org.codehaus.plexus.components.io.resources
Class PlexusIoCompressedFileResourceCollection

java.lang.Object
  org.codehaus.plexus.components.io.resources.PlexusIoCompressedFileResourceCollection

All Implemented Interfaces:

PlexusIoArchivedResourceCollection, PlexusIoResourceCollection

public abstract class PlexusIoCompressedFileResourceCollection
extends Object
implements PlexusIoArchivedResourceCollection

Abstract base class for compressed files, aka singleton resource collections.

Field Summary

Fields inherited from interface org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection

DEFAULT_ROLE_HINT, ROLE

Constructor Summary

PlexusIoCompressedFileResourceCollection()

Method Summary

protected abstract String	getDefaultExtension()
File	getFile() Returns the archive file
protected abstract InputStream	getInputStream(File file)
long	getLastModified() Returns the collections last modification time.
protected String	getName(File file)
String	getName(PlexusIoResource resource) Returns the resources suggested name.
String	getPath()
Iterator<PlexusIoResource>	getResources() Returns an iterator over the resources in the collection.
void	setFile(File file) Sets the arcihve file
void	setPath(String path)

Methods inherited from class java.lang.Object

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

Constructor Detail

PlexusIoCompressedFileResourceCollection

public PlexusIoCompressedFileResourceCollection()

Method Detail

getFile

public File getFile()

Description copied from interface: PlexusIoArchivedResourceCollection

Returns the archive file

Specified by:

getFile in interface PlexusIoArchivedResourceCollection

setFile

public void setFile(File file)

Description copied from interface: PlexusIoArchivedResourceCollection

Sets the arcihve file

Specified by:

setFile in interface PlexusIoArchivedResourceCollection

getPath

public String getPath()

setPath

public void setPath(String path)

getResources

public Iterator<PlexusIoResource> getResources()
                                        throws IOException

Description copied from interface: PlexusIoResourceCollection

Returns an iterator over the resources in the collection.

Specified by:

getResources in interface PlexusIoResourceCollection

Returns:

An iterator

Throws:

IOException - .

getName

protected String getName(File file)
                  throws IOException

Throws:

IOException

getDefaultExtension

protected abstract String getDefaultExtension()

getInputStream

protected abstract InputStream getInputStream(File file)
                                       throws IOException

Throws:

IOException

getName

public String getName(PlexusIoResource resource)
               throws IOException

Description copied from interface: PlexusIoResourceCollection

Returns the resources suggested name. This is used for integrating file mappers.

Specified by:

getName in interface PlexusIoResourceCollection

Parameters:

resource - A resource, which has been obtained by calling PlexusIoResourceCollection.getResources().

Returns:

The resource name

Throws:

IOException - .

getLastModified

public long getLastModified()
                     throws IOException

Description copied from interface: PlexusIoResourceCollection

Returns the collections last modification time. For a collection of files, this might be the last modification time of the file, which has been modified at last. For an archive file, this might be the modification time of the archive file.

Specified by:

getLastModified in interface PlexusIoResourceCollection

Returns:

PlexusIoResource.UNKNOWN_MODIFICATION_DATE, if the collections last modification time is unknown, otherwise the last modification time in milliseconds.

Throws:

IOException - .