org.ringojs.repository

Class AbstractRepository

java.lang.Object

org.ringojs.repository.AbstractRepository

All Implemented Interfaces:

Serializable, Repository, Trackable

Direct Known Subclasses:

FileRepository, WebappRepository, ZipRepository

public abstract class AbstractRepository
extends Object
implements Repository

Provides common methods and fields for the default implementations of the repository interface

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.ringojs.repository.Repository

SEPARATOR

Constructor Summary

Constructors

Constructor and Description
AbstractRepository()

Method Summary

Modifier and Type	Method and Description
protected abstract AbstractRepository	createChildRepository(String name) Create a new child reposiotory with the given name.
AbstractRepository	getChildRepository(String subpath) Get a child repository with the given name
String	getModuleName() Utility method to get the name for the module defined by this resource.
String	getName() Get the local name that identifies this repository locally within its parent repository
AbstractRepository	getParentRepository() Get this repository's parent repository.
String	getPath() Get the full name that identifies this repository globally
String	getRelativePath() Get the path of this repository relative to its root repository.
Resource	getResource(String subpath) Get a resource contained in this repository identified by the given local name.
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.
protected abstract void	getResources(List<Resource> list, boolean recursive) Add the repository's resources into the list, optionally descending into nested repositories.
Resource[]	getResources(String resourcePath, boolean recursive) Get a list of resources contained in this repository identified by the given local name.
Repository	getRootRepository() Get the repository's root repository
boolean	isAbsolute() Return true if this Repository is in absolute mode.
protected AbstractRepository	lookupRepository(String name)
protected abstract Resource	lookupResource(String name) Called to create a child resource for this repository if it exists.
protected String[]	resolve(String path, boolean absolute) Resolve path relative to this repository.
void	setAbsolute(boolean absolute) Set this Repository to absolute mode.
void	setRoot() Mark this repository as root repository.
String	toString() Returns the repositories full path as string representation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ringojs.repository.Repository

getRepositories

Methods inherited from interface org.ringojs.repository.Trackable

exists, getChecksum, getUrl, lastModified

Constructor Detail

AbstractRepository

public AbstractRepository()

Method Detail

lookupResource

protected abstract Resource lookupResource(String name)
                                    throws IOException

Called to create a child resource for this repository if it exists.

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

createChildRepository

protected abstract AbstractRepository createChildRepository(String name)
                                                     throws IOException

Create a new child reposiotory with the given name.

Parameters:

name - the name

Returns:

the new child repository

Throws:

IOException - an I/O error occurred

getResources

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

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

Parameters:

list - the list to add the resources to

recursive - whether to descend into nested repositories

Throws:

IOException - an I/O related error occurred

getPath

public String getPath()

Get the full name that identifies this repository globally

Specified by:

getPath in interface Trackable

Returns:

path of the resource

getName

public String getName()

Get the local name that identifies this repository locally within its parent repository

Specified by:

getName in interface Trackable

Returns:

short name of the resource

setRoot

public void setRoot()

Mark this repository as root repository.

Specified by:

setRoot in interface Repository

setAbsolute

public void setAbsolute(boolean absolute)

Set this Repository to absolute mode. This will cause all its relative path operations to use absolute paths instead.

Specified by:

setAbsolute in interface Trackable

Parameters:

absolute - true to operate in absolute mode

isAbsolute

public boolean isAbsolute()

Return true if this Repository is in absolute mode.

Specified by:

isAbsolute in interface Trackable

Returns:

true if absolute mode is on

getRelativePath

public String getRelativePath()

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

Specified by:

getRelativePath in interface Repository

Specified by:

getRelativePath in interface Trackable

Returns:

the repository path

getModuleName

public String getModuleName()

Utility method to get the name for the module defined by this resource.

Specified by:

getModuleName in interface Trackable

Returns:

the module name according to the securable module spec

resolve

protected String[] resolve(String path,
                           boolean absolute)

Resolve path relative to this repository.

Parameters:

path - a path string

absolute - whether to return an absolute path that can be used without this repository

Returns:

a List containing the path elements resolved relative to this repository

getResource

public Resource getResource(String subpath)
                     throws IOException

Get a resource contained in this repository identified by the given local name. If the name can't be resolved to a resource, a resource object is returned for which exists() returns false.

Specified by:

getResource in interface Repository

Parameters:

subpath - name of the child resource to return

Returns:

specified child resource

Throws:

IOException

getChildRepository

public AbstractRepository getChildRepository(String subpath)
                                      throws IOException

Get a child repository with the given name

Specified by:

getChildRepository in interface Repository

Parameters:

subpath - the name of the repository

Returns:

the child repository

Throws:

IOException - an IOException occurred

lookupRepository

protected AbstractRepository lookupRepository(String name)
                                       throws IOException

Throws:

IOException

getParentRepository

public AbstractRepository getParentRepository()

Get this repository's parent repository.

Specified by:

getParentRepository in interface Trackable

Returns:

parent repository

getRootRepository

public Repository getRootRepository()

Get the repository's root repository

Specified by:

getRootRepository in interface Trackable

Returns:

root repository

getResources

public Resource[] getResources()
                        throws IOException

Description copied from interface: Repository

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

Specified by:

getResources in interface Repository

Returns:

a list of all direct child resources

Throws:

IOException

getResources

public Resource[] getResources(boolean recursive)
                        throws IOException

Description copied from interface: Repository

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

Specified by:

getResources in interface Repository

Parameters:

recursive - whether to include nested resources

Returns:

a list of all nested child resources

Throws:

IOException

getResources

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

Description copied from interface: Repository

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

Specified by:

getResources in interface Repository

Parameters:

resourcePath - the repository path

recursive - whether to include nested resources

Returns:

a list of all nested child resources

Throws:

IOException

toString

public String toString()

Returns the repositories full path as string representation.

Overrides:

toString in class Object

See Also:

getPath()