Package org.apache.rat.config

Enum SourceCodeManagementSystems

java.lang.Object

java.lang.Enum<SourceCodeManagementSystems>

org.apache.rat.config.SourceCodeManagementSystems

All Implemented Interfaces:

Serializable, Comparable<SourceCodeManagementSystems>

public enum SourceCodeManagementSystems
extends Enum<SourceCodeManagementSystems>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BAZAAR
CVS
GIT
MERCURIAL
SUBVERSION

Method Summary

Modifier and Type	Method	Description
List<String>	getExclusions()	If an ignore file exists it's added as
String	getIgnoreFile()	Maybe null, check before with
static List<String>	getPluginExclusions()	Calls getExclusions() on each SCM to generate a global list of exclusions to be used during RAT runs.
boolean	hasIgnoreFile()
static SourceCodeManagementSystems	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SourceCodeManagementSystems[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUBVERSION

public static final SourceCodeManagementSystems SUBVERSION

GIT

public static final SourceCodeManagementSystems GIT

BAZAAR

public static final SourceCodeManagementSystems BAZAAR

MERCURIAL

public static final SourceCodeManagementSystems MERCURIAL

CVS

public static final SourceCodeManagementSystems CVS

Method Details

values

public static SourceCodeManagementSystems[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SourceCodeManagementSystems valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getExclusions

public List<String> getExclusions()

If an ignore file exists it's added as

 *⁄.scm⁄*
 

. Otherwise the technical directory of the SCM is added as

 **⁄.scmignore
 

to be used as exclusion during RAT runs.

Returns:

list of excludes if the current SCM is used.

hasIgnoreFile

public boolean hasIgnoreFile()

getPluginExclusions

public static List<String> getPluginExclusions()

Calls getExclusions() on each SCM to generate a global list of exclusions to be used during RAT runs.

Returns:

the global list of exclusions usable for all known SCM.

getIgnoreFile

public String getIgnoreFile()

Maybe null, check before with

Returns:

the ignore file of the SCM.

See Also:

hasIgnoreFile()