org.ringojs.repository

Class ZipRepository

java.lang.Object

org.ringojs.repository.AbstractRepository

org.ringojs.repository.ZipRepository

All Implemented Interfaces:

Serializable, Repository, Trackable

public final class ZipRepository
extends AbstractRepository

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.ringojs.repository.Repository

SEPARATOR

Constructor Summary

Constructors

Constructor and Description
ZipRepository(File file) Constructs a ZipRespository using the given zip file.
ZipRepository(String path) Constructs a ZipRespository using the given zip file.

Method Summary

Modifier and Type	Method and Description
protected AbstractRepository	createChildRepository(String name) Create a new child reposiotory with the given name.
boolean	equals(Object obj)
boolean	exists() Checks wether this resource actually (still) exists
long	getChecksum() Checksum of the resource content.
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.
protected ZipFile	getZipFile() Returns a java.util.zip.ZipFile for this repository.
int	hashCode()
long	lastModified() Returns the date the resource 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, getParentRepository, 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

Constructor Detail

ZipRepository

public ZipRepository(String path)
              throws ZipException,
                     IOException

Constructs a ZipRespository using the given zip file.

Parameters:

path - path to zip file

Throws:

ZipException - a zip encoding related error occurred

IOException - an I/O error occurred

ZipRepository

public ZipRepository(File file)
              throws ZipException,
                     IOException

Constructs a ZipRespository using the given zip file.

Parameters:

file - zip file

Throws:

ZipException - a zip encoding related error occurred

IOException - an I/O error occurred

Method Detail

getZipFile

protected ZipFile getZipFile()
                      throws IOException

Returns a java.util.zip.ZipFile for this repository.

Returns:

a ZipFile for reading

Throws:

IOException - an I/O related error occurred

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

exists

public boolean exists()
               throws IOException

Checks wether this resource actually (still) exists

Returns:

true if the resource exists

Throws:

IOException

createChildRepository

protected AbstractRepository createChildRepository(String name)
                                            throws IOException

Description copied from class: AbstractRepository

Create a new child reposiotory with the given name.

Specified by:

createChildRepository in class AbstractRepository

Parameters:

name - the name

Returns:

the new child repository

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

lastModified

public long lastModified()

Description copied from interface: Trackable

Returns the date the resource was last modified

Returns:

last modified date

getChecksum

public long getChecksum()

Description copied from interface: Trackable

Checksum of the resource content. Implementations should make sure to return a different checksum if the resource's content has changed.

Returns:

checksum

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()