org.ringojs.repository

Class FileRepository

java.lang.Object

org.ringojs.repository.AbstractRepository

org.ringojs.repository.FileRepository

All Implemented Interfaces:

Serializable, Repository, Trackable

public class FileRepository
extends AbstractRepository

Repository implementation for directories providing file resources

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected File	directory
protected long	lastChecksum
protected long	lastChecksumTime
protected long	lastModified

Fields inherited from interface org.ringojs.repository.Repository

SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
	FileRepository(File dir) Constructs a FileRepository using the given directory as top-level repository
protected	FileRepository(File dir, FileRepository parent) Constructs a FileRepository using the given directory and top-level repository
	FileRepository(String path) Constructs a FileRepository using the given argument

Method Summary

Modifier and Type	Method and Description
AbstractRepository	createChildRepository(String name) Create a child repository with the given name
boolean	equals(Object obj)
boolean	exists() Check whether the repository exists.
long	getChecksum() Checksum of the repository and all its contained resources.
AbstractRepository	getParentRepository() Get this repository's parent repository.
Repository[]	getRepositories() Returns this repository's direct child repositories
protected void	getResources(List<Resource> list, boolean recursive) Add the repository's resources into the list, optionally descending into nested repositories.
URL	getUrl() Returns an url to the resource if the repository of this resource is able to provide urls.
int	hashCode()
long	lastModified() Returns the date the repository was last modified.
protected Resource	lookupResource(String name) Called to create a child resource for this repository
String	toString() Returns the repositories full path as string representation.

Methods inherited from class org.ringojs.repository.AbstractRepository

getChildRepository, getModuleName, getName, getPath, getRelativePath, getResource, getResources, getResources, getResources, getRootRepository, isAbsolute, lookupRepository, resolve, setAbsolute, setRoot

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

directory

protected final File directory

lastModified

protected long lastModified

lastChecksum

protected long lastChecksum

lastChecksumTime

protected long lastChecksumTime

Constructor Detail

FileRepository

public FileRepository(String path)
               throws IOException

Constructs a FileRepository using the given argument

Parameters:

path - absolute path to the directory

Throws:

IOException - if canonical path couldn't be resolved

FileRepository

public FileRepository(File dir)
               throws IOException

Constructs a FileRepository using the given directory as top-level repository

Parameters:

dir - directory

Throws:

IOException - if canonical path couldn't be resolved

FileRepository

protected FileRepository(File dir,
                         FileRepository parent)
                  throws IOException

Constructs a FileRepository using the given directory and top-level repository

Parameters:

dir - directory

parent - top-level repository

Throws:

IOException - if canonical path couldn't be resolved

Method Detail

exists

public boolean exists()

Check whether the repository exists.

Returns:

true if the repository exists.

createChildRepository

public AbstractRepository createChildRepository(String name)
                                         throws IOException

Create a child repository with the given name

Specified by:

createChildRepository in class AbstractRepository

Parameters:

name - the name of the repository

Returns:

the child repository

Throws:

IOException - an I/O error occurred

getParentRepository

public AbstractRepository getParentRepository()

Get this repository's parent repository.

Specified by:

getParentRepository in interface Trackable

Overrides:

getParentRepository in class AbstractRepository

Returns:

parent repository

lastModified

public long lastModified()

Returns the date the repository was last modified.

Returns:

last modified date

getChecksum

public long getChecksum()
                 throws IOException

Checksum of the repository and all its contained resources. Implementations should make sure to return a different checksum if any contained resource has changed.

Returns:

checksum

Throws:

IOException

lookupResource

protected Resource lookupResource(String name)
                           throws IOException

Called to create a child resource for this repository

Specified by:

lookupResource in class AbstractRepository

Parameters:

name - the name of the child resource

Returns:

the child resource, or null if no resource with the given name exists

Throws:

IOException - an I/O error occurred

getResources

protected void getResources(List<Resource> list,
                            boolean recursive)
                     throws IOException

Description copied from class: AbstractRepository

Add the repository's resources into the list, optionally descending into nested repositories.

Specified by:

getResources in class AbstractRepository

Parameters:

list - the list to add the resources to

recursive - whether to descend into nested repositories

Throws:

IOException - an I/O related error occurred

getRepositories

public Repository[] getRepositories()
                             throws IOException

Description copied from interface: Repository

Returns this repository's direct child repositories

Returns:

direct repositories

Throws:

IOException - an I/O error occurred

getUrl

public URL getUrl()
           throws MalformedURLException

Description copied from interface: Trackable

Returns an url to the resource if the repository of this resource is able to provide urls.

Returns:

url to the resource

Throws:

MalformedURLException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Description copied from class: AbstractRepository

Returns the repositories full path as string representation.

Overrides:

toString in class AbstractRepository

See Also:

AbstractRepository.getPath()