org.codehaus.plexus.components.io.resources.proxy

Class PlexusIoProxyResourceCollection

java.lang.Object

org.codehaus.plexus.components.io.resources.AbstractPlexusIoResourceCollection

org.codehaus.plexus.components.io.resources.AbstractPlexusIoResourceCollectionWithAttributes

org.codehaus.plexus.components.io.resources.proxy.PlexusIoProxyResourceCollection

All Implemented Interfaces:

PlexusIoResourceCollection, PlexusIOResourceCollectionWithAttributes, org.codehaus.plexus.logging.LogEnabled

public class PlexusIoProxyResourceCollection
extends AbstractPlexusIoResourceCollectionWithAttributes

Implementation of PlexusIoResourceCollection for an archives contents.

Field Summary

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

DEFAULT_ROLE_HINT, ROLE

Constructor Summary

Constructors

Constructor and Description
PlexusIoProxyResourceCollection()

Method Summary

Methods

Modifier and Type	Method and Description
protected FileSelector	getDefaultFileSelector()
long	getLastModified() Returns the collections last modification time.
String	getName(PlexusIoResource resource) Returns the resources suggested name.
Iterator<PlexusIoResource>	getResources() Returns an iterator over the resources in the collection.
PlexusIoResourceCollection	getSrc() Returns the archive to read.
void	setDefaultAttributes(int uid, String userName, int gid, String groupName, int fileMode, int dirMode) Sets the file and directory attributes to use as defaults.
void	setOverrideAttributes(int uid, String userName, int gid, String groupName, int fileMode, int dirMode) Sets the file and directory attributes to use as overrides.
void	setSrc(PlexusIoResourceCollection src) Sets the archive to read.

Methods inherited from class org.codehaus.plexus.components.io.resources.AbstractPlexusIoResourceCollectionWithAttributes

getDefaultDirAttributes, getDefaultFileAttributes, getOverrideDirAttributes, getOverrideFileAttributes, setDefaultDirAttributes, setDefaultFileAttributes, setOverrideDirAttributes, setOverrideFileAttributes

Methods inherited from class org.codehaus.plexus.components.io.resources.AbstractPlexusIoResourceCollection

enableLogging, getExcludes, getFileMappers, getFileSelectors, getIncludes, getLogger, getPrefix, isCaseSensitive, isIncludingEmptyDirectories, isSelected, isUsingDefaultExcludes, setCaseSensitive, setExcludes, setFileMappers, setFileSelectors, setIncludes, setIncludingEmptyDirectories, setPrefix, setUsingDefaultExcludes

Methods inherited from class java.lang.Object

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

Constructor Detail

PlexusIoProxyResourceCollection

public PlexusIoProxyResourceCollection()

Method Detail

setSrc

public void setSrc(PlexusIoResourceCollection src)

Sets the archive to read.

getSrc

public PlexusIoResourceCollection getSrc()

Returns the archive to read.

setDefaultAttributes

public void setDefaultAttributes(int uid,
                        String userName,
                        int gid,
                        String groupName,
                        int fileMode,
                        int dirMode)

Description copied from interface: PlexusIOResourceCollectionWithAttributes

Sets the file and directory attributes to use as defaults.

fileMode - The octal mode to use for files

dirMode - The octal mode to use for directories

setOverrideAttributes

public void setOverrideAttributes(int uid,
                         String userName,
                         int gid,
                         String groupName,
                         int fileMode,
                         int dirMode)

Description copied from interface: PlexusIOResourceCollectionWithAttributes

Sets the file and directory attributes to use as overrides.

fileMode - The octal mode to use for files

dirMode - The octal mode to use for directories

getDefaultFileSelector

protected FileSelector getDefaultFileSelector()

getResources

public Iterator<PlexusIoResource> getResources()
                                        throws IOException

Description copied from interface: PlexusIoResourceCollection

Returns an iterator over the resources in the collection.

Returns:

An iterator

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

Overrides:

getName in class AbstractPlexusIoResourceCollection

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

Overrides:

getLastModified in class AbstractPlexusIoResourceCollection

Returns:

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

Throws:

IOException - .