org.codehaus.plexus.archiver.util

Class AbstractFileSet<T extends AbstractFileSet>

java.lang.Object

org.codehaus.plexus.archiver.util.AbstractFileSet<T>

All Implemented Interfaces:

BaseFileSet

Direct Known Subclasses:

DefaultArchivedFileSet, DefaultFileSet

public abstract class AbstractFileSet<T extends AbstractFileSet>
extends Object
implements BaseFileSet

Default implementation of BaseFileSet.

Since:

1.0-alpha-9

Constructor Summary

Constructors

Constructor and Description
AbstractFileSet()

Method Summary

Methods

Modifier and Type	Method and Description
T	exclude(String[] excludes)
String[]	getExcludes() Returns a string of patterns, which excluded files should match.
org.codehaus.plexus.components.io.filemappers.FileMapper[]	getFileMappers() Returns a set of file mappers, which should be used to change the filename of the included files.
org.codehaus.plexus.components.io.fileselectors.FileSelector[]	getFileSelectors() Returns a set of file selectors, which should be used to select the included files.
String[]	getIncludes() Returns a string of patterns, which included files should match.
String	getPrefix() Returns the prefix, which the file sets contents shall have.
org.codehaus.plexus.components.io.functions.InputStreamTransformer	getStreamTransformer() Returns the InputStreamTransformers that can be applied to this fileset
T	include(String[] includes)
T	includeEmptyDirs(boolean includeEmptyDirectories)
T	includeExclude(String[] includes, String[] excludes)
boolean	isCaseSensitive() Returns, whether the include/exclude patterns are case sensitive.
boolean	isIncludingEmptyDirectories() Returns, whether empty directories are being included.
boolean	isUsingDefaultExcludes() Returns, whether the default excludes are being applied.
T	prefixed(String prefix)
void	setCaseSensitive(boolean caseSensitive) Sets, whether the include/exclude patterns are case sensitive.
void	setExcludes(String[] excludes) Sets a string of patterns, which excluded files should match.
void	setFileMappers(org.codehaus.plexus.components.io.filemappers.FileMapper[] fileMappers) Sets a set of file mappers, which should be used to change the filename of the included files.
void	setFileSelectors(org.codehaus.plexus.components.io.fileselectors.FileSelector[] fileSelectors) Sets a set of file selectors, which should be used to select the included files.
void	setIncludes(String[] includes) Sets a string of patterns, which included files should match.
void	setIncludingEmptyDirectories(boolean includingEmptyDirectories) Sets, whether empty directories are being included.
void	setPrefix(String prefix) Sets the prefix, which the file sets contents shall have.
void	setStreamTransformer(org.codehaus.plexus.components.io.functions.InputStreamTransformer streamTransformer)
void	setUsingDefaultExcludes(boolean usingDefaultExcludes) Sets, whether the default excludes are being applied.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFileSet

public AbstractFileSet()

Method Detail

setExcludes

public void setExcludes(String[] excludes)

Sets a string of patterns, which excluded files should match.

getExcludes

public String[] getExcludes()

Description copied from interface: BaseFileSet

Returns a string of patterns, which excluded files should match.

Specified by:

getExcludes in interface BaseFileSet

setFileSelectors

public void setFileSelectors(org.codehaus.plexus.components.io.fileselectors.FileSelector[] fileSelectors)

Sets a set of file selectors, which should be used to select the included files.

getFileSelectors

public org.codehaus.plexus.components.io.fileselectors.FileSelector[] getFileSelectors()

Description copied from interface: BaseFileSet

Returns a set of file selectors, which should be used to select the included files.

Specified by:

getFileSelectors in interface BaseFileSet

setIncludes

public void setIncludes(String[] includes)

Sets a string of patterns, which included files should match.

getIncludes

public String[] getIncludes()

Description copied from interface: BaseFileSet

Returns a string of patterns, which included files should match.

Specified by:

getIncludes in interface BaseFileSet

setPrefix

public void setPrefix(String prefix)

Sets the prefix, which the file sets contents shall have.

getPrefix

public String getPrefix()

Description copied from interface: BaseFileSet

Returns the prefix, which the file sets contents shall have.

Specified by:

getPrefix in interface BaseFileSet

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

Sets, whether the include/exclude patterns are case sensitive. Defaults to true.

isCaseSensitive

public boolean isCaseSensitive()

Description copied from interface: BaseFileSet

Returns, whether the include/exclude patterns are case sensitive.

Specified by:

isCaseSensitive in interface BaseFileSet

setUsingDefaultExcludes

public void setUsingDefaultExcludes(boolean usingDefaultExcludes)

Sets, whether the default excludes are being applied. Defaults to true.

isUsingDefaultExcludes

public boolean isUsingDefaultExcludes()

Description copied from interface: BaseFileSet

Returns, whether the default excludes are being applied.

Specified by:

isUsingDefaultExcludes in interface BaseFileSet

setIncludingEmptyDirectories

public void setIncludingEmptyDirectories(boolean includingEmptyDirectories)

Sets, whether empty directories are being included. Defaults to true.

isIncludingEmptyDirectories

public boolean isIncludingEmptyDirectories()

Description copied from interface: BaseFileSet

Returns, whether empty directories are being included.

Specified by:

isIncludingEmptyDirectories in interface BaseFileSet

prefixed

public T prefixed(String prefix)

include

public T include(String[] includes)

exclude

public T exclude(String[] excludes)

includeExclude

public T includeExclude(String[] includes,
               String[] excludes)

includeEmptyDirs

public T includeEmptyDirs(boolean includeEmptyDirectories)

setStreamTransformer

public void setStreamTransformer(@Nonnull
                        org.codehaus.plexus.components.io.functions.InputStreamTransformer streamTransformer)

getStreamTransformer

public org.codehaus.plexus.components.io.functions.InputStreamTransformer getStreamTransformer()

Description copied from interface: BaseFileSet

Returns the InputStreamTransformers that can be applied to this fileset

Specified by:

getStreamTransformer in interface BaseFileSet

Returns:

The transformers.

setFileMappers

public void setFileMappers(org.codehaus.plexus.components.io.filemappers.FileMapper[] fileMappers)

Sets a set of file mappers, which should be used to change the filename of the included files.

getFileMappers

public org.codehaus.plexus.components.io.filemappers.FileMapper[] getFileMappers()

Description copied from interface: BaseFileSet

Returns a set of file mappers, which should be used to change the filename of the included files.

Specified by:

getFileMappers in interface BaseFileSet