org.ringojs.repository

Interface Repository

All Superinterfaces:

Serializable, Trackable

All Known Implementing Classes:

AbstractRepository, FileRepository, WebappRepository, ZipRepository

public interface Repository
extends Trackable

Repository represents an abstract container of resources (e.g. code, skins, ...). In addition to resources, repositories may contain other repositories, building a hierarchical structure.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEPARATOR String containing file separator characters.

Method Summary

Modifier and Type	Method and Description
Repository	getChildRepository(String path) Get a child repository with the given path
String	getRelativePath() Get the path of this repository relative to its root repository.
Repository[]	getRepositories() Returns this repository's direct child repositories
Resource	getResource(String resourceName) Returns a specific direct resource of the repository
Resource[]	getResources() Get a list of resources contained in this repository identified by the given local name.
Resource[]	getResources(boolean recursive) Get a list of resources contained in this repository identified by the given local name.
Resource[]	getResources(String resourcePath, boolean recursive) Get a list of resources contained in this repository identified by the given local name.
void	setRoot() Mark this repository as root repository, disabling any parent access.

Methods inherited from interface org.ringojs.repository.Trackable

exists, getChecksum, getModuleName, getName, getParentRepository, getPath, getRootRepository, getUrl, isAbsolute, lastModified, setAbsolute

Field Detail

SEPARATOR

static final String SEPARATOR

String containing file separator characters. Always include slash character, plus the native separator char if it isn't the slash.

Method Detail

getResource

Resource getResource(String resourceName)
              throws IOException

Returns a specific direct resource of the repository

Parameters:

resourceName - name of the child resource to return

Returns:

specified child resource

Throws:

IOException

getResources

Resource[] getResources()
                 throws IOException

Get a list of resources contained in this repository identified by the given local name.

Returns:

a list of all direct child resources

Throws:

IOException

getResources

Resource[] getResources(boolean recursive)
                 throws IOException

Get a list of resources contained in this repository identified by the given local name.

Parameters:

recursive - whether to include nested resources

Returns:

a list of all nested child resources

Throws:

IOException

getResources

Resource[] getResources(String resourcePath,
                        boolean recursive)
                 throws IOException

Get a list of resources contained in this repository identified by the given local name.

Parameters:

resourcePath - the repository path

recursive - whether to include nested resources

Returns:

a list of all nested child resources

Throws:

IOException

getRepositories

Repository[] getRepositories()
                      throws IOException

Returns this repository's direct child repositories

Returns:

direct repositories

Throws:

IOException - an I/O error occurred

getChildRepository

Repository getChildRepository(String path)
                       throws IOException

Get a child repository with the given path

Parameters:

path - the path of the repository

Returns:

the child repository

Throws:

IOException - an IOException occurred

setRoot

void setRoot()

Mark this repository as root repository, disabling any parent access.

getRelativePath

String getRelativePath()

Get the path of this repository relative to its root repository.

Specified by:

getRelativePath in interface Trackable

Returns:

the repository path