org.codehaus.plexus.components.io.resources

Class PlexusIoCompressedFileResourceCollection

java.lang.Object

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

All Implemented Interfaces:

Iterable<PlexusIoResource>, PlexusIoArchivedResourceCollection, PlexusIoResourceCollection

public abstract class PlexusIoCompressedFileResourceCollection
extends Object
implements PlexusIoArchivedResourceCollection, Iterable<PlexusIoResource>

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

Constructors

Constructor and Description
PlexusIoCompressedFileResourceCollection()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract PlexusIoResourceAttributes	getAttributes(File f)
protected abstract String	getDefaultExtension()
File	getFile() Returns the archive file
protected abstract InputStream	getInputStream(File file)
InputStream	getInputStream(PlexusIoResource resource) Returns an input stream for the provided resource, with stream transformers applied
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.
Iterator<PlexusIoResource>	iterator()
PlexusIoResource	resolve(PlexusIoResource resource) Resolves the supplide resource into a "real" resource.
void	setFile(File file) Sets the arcihve file
void	setPath(String path)
void	setStreamTransformer(InputStreamTransformer streamTransformers)

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)

getAttributes

protected abstract PlexusIoResourceAttributes getAttributes(File f)
                                                     throws IOException

Throws:

IOException

setStreamTransformer

public void setStreamTransformer(InputStreamTransformer streamTransformers)

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

@Nonnull
protected abstract InputStream getInputStream(File file)
                                       throws IOException

Throws:

IOException

getInputStream

public InputStream getInputStream(PlexusIoResource resource)
                           throws IOException

Description copied from interface: PlexusIoResourceCollection

Returns an input stream for the provided resource, with stream transformers applied

Specified by:

getInputStream in interface PlexusIoResourceCollection

Parameters:

resource - The resources

Returns:

A possibly transformed resource

Throws:

IOException - when something goes bad

resolve

public PlexusIoResource resolve(PlexusIoResource resource)
                         throws IOException

Description copied from interface: PlexusIoResourceCollection

Resolves the supplide resource into a "real" resource. Resolving means applying input transformations Returns an input stream for the provided resource, with stream transformers applied

Specified by:

resolve in interface PlexusIoResourceCollection

Parameters:

resource - The resources

Returns:

A possibly transformed resource

Throws:

IOException - when something goes bad

iterator

public Iterator<PlexusIoResource> iterator()

Specified by:

iterator in interface Iterable<PlexusIoResource>

getName

public String getName(PlexusIoResource resource)

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. If it is a file, it should be normalized to platform separators

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 - .