org.apache.rat.config

Enum SourceCodeManagementSystems

java.lang.Object

java.lang.Enum<SourceCodeManagementSystems>

org.apache.rat.config.SourceCodeManagementSystems

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SourceCodeManagementSystems>

public enum SourceCodeManagementSystems
extends java.lang.Enum<SourceCodeManagementSystems>

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAZAAR
CVS
GIT
MERCURIAL
SUBVERSION

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	directory Technical directory of that SCM which contains SCM internals.
private java.lang.String	ignoreFile If there is a external way to configure files to be ignored: name of this file, null otherwise.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getExclusions() If an ignore file exists it's added as
java.lang.String	getIgnoreFile() Maybe null, check before with
static java.util.List<java.lang.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(java.lang.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 Detail

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

Field Detail

directory

private java.lang.String directory

Technical directory of that SCM which contains SCM internals.

ignoreFile

private java.lang.String ignoreFile

If there is a external way to configure files to be ignored: name of this file, null otherwise.

Method Detail

values

public static SourceCodeManagementSystems[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SourceCodeManagementSystems c : SourceCodeManagementSystems.values())
    System.out.println(c);

Returns:

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

valueOf

public static SourceCodeManagementSystems valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getExclusions

public java.util.List<java.lang.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 java.util.List<java.lang.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 java.lang.String getIgnoreFile()

Maybe null, check before with

Returns:

the ignore file of the SCM.

See Also:

hasIgnoreFile()