org.apache.maven.plugin.assembly.model
Class SetBase

java.lang.Object
  extended by org.apache.maven.plugin.assembly.model.SetBase
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
DependencySet, FileSet, ModuleBinaries, ModuleSources, Repository

public class SetBase
extends Object
implements Serializable

Class SetBase.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
SetBase()
           
 
Method Summary
 void addExclude(String string)
          Method addExclude.
 void addInclude(String string)
          Method addInclude.
 String getDirectoryMode()
          Get similar to a UNIX permission, sets the directory mode of the directories included.
 List<String> getExcludes()
          Method getExcludes.
 String getFileMode()
          Get similar to a UNIX permission, sets the file mode of the files included.
 List<String> getIncludes()
          Method getIncludes.
 String getOutputDirectory()
          Get sets the output directory relative to the root of the root directory of the assembly.
 boolean isUseDefaultExcludes()
          Get whether standard exclusion patterns, such as those matching CVS and Subversion metadata files, should be used when calculating the files affected by this set.
 boolean isUseStrictFiltering()
          Get when specified as true, any include/exclude patterns which aren't used to filter an actual artifact during assembly creation will cause the build to fail with an error.
 void removeExclude(String string)
          Method removeExclude.
 void removeInclude(String string)
          Method removeInclude.
 void setDirectoryMode(String directoryMode)
          Set similar to a UNIX permission, sets the directory mode of the directories included.
 void setExcludes(List<String> excludes)
          Set when <exclude> subelements are present, they define a set of files and directory to exclude.
 void setFileMode(String fileMode)
          Set similar to a UNIX permission, sets the file mode of the files included.
 void setIncludes(List<String> includes)
          Set when <include> subelements are present, they define a set of files and directory to include.
 void setOutputDirectory(String outputDirectory)
          Set sets the output directory relative to the root of the root directory of the assembly.
 void setUseDefaultExcludes(boolean useDefaultExcludes)
          Set whether standard exclusion patterns, such as those matching CVS and Subversion metadata files, should be used when calculating the files affected by this set.
 void setUseStrictFiltering(boolean useStrictFiltering)
          Set when specified as true, any include/exclude patterns which aren't used to filter an actual artifact during assembly creation will cause the build to fail with an error.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SetBase

public SetBase()
Method Detail

addExclude

public void addExclude(String string)
Method addExclude.

Parameters:
string -

addInclude

public void addInclude(String string)
Method addInclude.

Parameters:
string -

getDirectoryMode

public String getDirectoryMode()
Get similar to a UNIX permission, sets the directory mode of the directories included. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0755 translates to User read-write, Group and Other read-only. (more on unix-style permissions)

Returns:
String

getExcludes

public List<String> getExcludes()
Method getExcludes.

Returns:
List

getFileMode

public String getFileMode()
Get similar to a UNIX permission, sets the file mode of the files included. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0644 translates to User read-write, Group and Other read-only. (more on unix-style permissions)

Returns:
String

getIncludes

public List<String> getIncludes()
Method getIncludes.

Returns:
List

getOutputDirectory

public String getOutputDirectory()
Get sets the output directory relative to the root of the root directory of the assembly. For example, "log" will put the specified files in the log directory.

Returns:
String

isUseDefaultExcludes

public boolean isUseDefaultExcludes()
Get whether standard exclusion patterns, such as those matching CVS and Subversion metadata files, should be used when calculating the files affected by this set. For backward compatibility, the default value is true.

Returns:
boolean

isUseStrictFiltering

public boolean isUseStrictFiltering()
Get when specified as true, any include/exclude patterns which aren't used to filter an actual artifact during assembly creation will cause the build to fail with an error. This is meant to highlight obsolete inclusions or exclusions, or else signal that the assembly descriptor is incorrectly configured.

Returns:
boolean

removeExclude

public void removeExclude(String string)
Method removeExclude.

Parameters:
string -

removeInclude

public void removeInclude(String string)
Method removeInclude.

Parameters:
string -

setDirectoryMode

public void setDirectoryMode(String directoryMode)
Set similar to a UNIX permission, sets the directory mode of the directories included. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0755 translates to User read-write, Group and Other read-only. (more on unix-style permissions)

Parameters:
directoryMode -

setExcludes

public void setExcludes(List<String> excludes)
Set when <exclude> subelements are present, they define a set of files and directory to exclude. If none is present, then <excludes> represents no exclusions.

Parameters:
excludes -

setFileMode

public void setFileMode(String fileMode)
Set similar to a UNIX permission, sets the file mode of the files included. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0644 translates to User read-write, Group and Other read-only. (more on unix-style permissions)

Parameters:
fileMode -

setIncludes

public void setIncludes(List<String> includes)
Set when <include> subelements are present, they define a set of files and directory to include. If none is present, then <includes> represents all valid values.

Parameters:
includes -

setOutputDirectory

public void setOutputDirectory(String outputDirectory)
Set sets the output directory relative to the root of the root directory of the assembly. For example, "log" will put the specified files in the log directory.

Parameters:
outputDirectory -

setUseDefaultExcludes

public void setUseDefaultExcludes(boolean useDefaultExcludes)
Set whether standard exclusion patterns, such as those matching CVS and Subversion metadata files, should be used when calculating the files affected by this set. For backward compatibility, the default value is true.

Parameters:
useDefaultExcludes -

setUseStrictFiltering

public void setUseStrictFiltering(boolean useStrictFiltering)
Set when specified as true, any include/exclude patterns which aren't used to filter an actual artifact during assembly creation will cause the build to fail with an error. This is meant to highlight obsolete inclusions or exclusions, or else signal that the assembly descriptor is incorrectly configured.

Parameters:
useStrictFiltering -


Copyright © 2002-2012 The Apache Software Foundation. All Rights Reserved.