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

java.lang.Object
  org.codehaus.plexus.components.io.resources.AbstractPlexusIoResourceCollection
      org.codehaus.plexus.components.io.resources.PlexusIoFileResourceCollection

All Implemented Interfaces:

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

public class PlexusIoFileResourceCollection
extends AbstractPlexusIoResourceCollection
implements PlexusIOResourceCollectionWithAttributes

Implementation of PlexusIoResourceCollection for the set of files in a common directory.

Field Summary

static java.lang.String

ROLE_HINT Role hint of this component

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

DEFAULT_ROLE_HINT, ROLE

Constructor Summary

PlexusIoFileResourceCollection()

PlexusIoFileResourceCollection(org.codehaus.plexus.logging.Logger logger)

Method Summary

java.io.File	getBaseDir()
java.util.Iterator<PlexusIoResource>	getResources() Returns an iterator over the resources in the collection.
boolean	isFollowingSymLinks()
void	setBaseDir(java.io.File baseDir)
void	setDefaultAttributes(int uid, java.lang.String userName, int gid, java.lang.String groupName, int fileMode, int dirMode) Sets the file and directory attributes to use as defaults.
void	setFollowingSymLinks(boolean pIsFollowingSymLinks)
void	setOverrideAttributes(int uid, java.lang.String userName, int gid, java.lang.String groupName, int fileMode, int dirMode) Sets the file and directory attributes to use as overrides.

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

enableLogging, getExcludes, getFileMappers, getFileSelectors, getIncludes, getLastModified, getLogger, getName, 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

Field Detail

ROLE_HINT

public static final java.lang.String ROLE_HINT

Role hint of this component

See Also:

Constant Field Values

Constructor Detail

PlexusIoFileResourceCollection

public PlexusIoFileResourceCollection()

PlexusIoFileResourceCollection

public PlexusIoFileResourceCollection(org.codehaus.plexus.logging.Logger logger)

Method Detail

setDefaultAttributes

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

Description copied from interface: PlexusIOResourceCollectionWithAttributes

Sets the file and directory attributes to use as defaults.

Specified by:

setDefaultAttributes in interface PlexusIOResourceCollectionWithAttributes

fileMode - The octal mode to use for files

dirMode - The octal mode to use for directories

setOverrideAttributes

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

Description copied from interface: PlexusIOResourceCollectionWithAttributes

Sets the file and directory attributes to use as overrides.

Specified by:

setOverrideAttributes in interface PlexusIOResourceCollectionWithAttributes

fileMode - The octal mode to use for files

dirMode - The octal mode to use for directories

setBaseDir

public void setBaseDir(java.io.File baseDir)

Parameters:

baseDir - The base directory of the file collection

getBaseDir

public java.io.File getBaseDir()

Returns:

Returns the file collections base directory.

isFollowingSymLinks

public boolean isFollowingSymLinks()

Returns:

Returns, whether symbolic links should be followed. Defaults to true.

setFollowingSymLinks

public void setFollowingSymLinks(boolean pIsFollowingSymLinks)

Parameters:

pIsFollowingSymLinks - whether symbolic links should be followed

getResources

public java.util.Iterator<PlexusIoResource> getResources()
                                                  throws java.io.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:

java.io.IOException - .