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:

Iterable<PlexusIoResource>, EncodingSupported, PlexusIoResourceCollection

public class PlexusIoProxyResourceCollection
extends AbstractPlexusIoResourceCollectionWithAttributes
implements EncodingSupported

Implementation of PlexusIoResourceCollection for an archives contents.

Field Summary

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

identityTransformer

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

DEFAULT_ROLE_HINT, ROLE

Constructor Summary

Constructors

Constructor and Description
PlexusIoProxyResourceCollection(PlexusIoResourceCollection src)

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.
boolean	isConcurrentAccessSupported() Indicates if this collection supports concurrent access to its resources.
void	setDefaultAttributes(int uid, String userName, int gid, String groupName, int fileMode, int dirMode)
void	setEncoding(Charset charset) Supplies the encoding to be used for decoding filenames/paths
void	setOverrideAttributes(int uid, String userName, int gid, String groupName, int fileMode, int dirMode)
void	setStreamTransformer(InputStreamTransformer streamTransformer)
Stream	stream() Returns the resources as a stream.

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

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

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

getExcludes, getFileMappers, getFileSelectors, getIncludes, getInputStream, getName, getPrefix, getStreamTransformer, isCaseSensitive, isIncludingEmptyDirectories, isSelected, isUsingDefaultExcludes, iterator, resolve, 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(@Nonnull
                               PlexusIoResourceCollection src)

Method Detail

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)

setOverrideAttributes

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

setStreamTransformer

public void setStreamTransformer(InputStreamTransformer streamTransformer)

Overrides:

setStreamTransformer in class AbstractPlexusIoResourceCollection

getDefaultFileSelector

protected FileSelector getDefaultFileSelector()

stream

public Stream stream()

Description copied from interface: PlexusIoResourceCollection

Returns the resources as a stream.

Specified by:

stream in interface PlexusIoResourceCollection

Returns:

A stream for functional iteration

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

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

Overrides:

getName in class AbstractPlexusIoResourceCollection

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

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

setEncoding

public void setEncoding(Charset charset)

Description copied from interface: EncodingSupported

Supplies the encoding to be used for decoding filenames/paths

Specified by:

setEncoding in interface EncodingSupported

Parameters:

charset - The charset to use

isConcurrentAccessSupported

public boolean isConcurrentAccessSupported()

Description copied from interface: PlexusIoResourceCollection

Indicates if this collection supports concurrent access to its resources.

Some resource collections (like tar files) may not support efficient random access or seek operation so implementations that represent such collections may not be able to provide concurrent access to its resources. If implementation returns false, then it is not safe to access its methods and resources in concurrent fashion. For example it is not safe to read from two resources in two concurrent threads, to read a resource and iterate over the iterator returned by PlexusIoResourceCollection.getResources() in two concurrent threads, etc.

Please note that this method indicates concurrent support only for the collection, not for the individual resources. This means there is no guarantee that the resources returned by PlexusIoResourceCollection.resolve(PlexusIoResource) or the input stream returned by PlexusIoResourceCollection.getInputStream(PlexusIoResource) are thread-safe, even if true is returned.

Specified by:

isConcurrentAccessSupported in interface PlexusIoResourceCollection

Returns:

true if this collection supports concurrent access, otherwise false