org.apache.rat.config

Enum AddLicenseHeaders

java.lang.Object

java.lang.Enum<AddLicenseHeaders>

org.apache.rat.config.AddLicenseHeaders

All Implemented Interfaces:

Serializable, Comparable<AddLicenseHeaders>

public enum AddLicenseHeaders
extends Enum<AddLicenseHeaders>

Value of addLicenseHeaders configuration option.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FALSE Do not add headers
FORCED Add headers and overwrite the old file
TRUE Add license headers to a *.new file

Method Summary

Modifier and Type	Method and Description
static String	getValuesForHelp()
static AddLicenseHeaders	valueOf(String name) Returns the enum constant of this type with the specified name.
static AddLicenseHeaders[]	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

TRUE

public static final AddLicenseHeaders TRUE

Add license headers to a *.new file

FALSE

public static final AddLicenseHeaders FALSE

Do not add headers

FORCED

public static final AddLicenseHeaders FORCED

Add headers and overwrite the old file

Method Detail

values

public static AddLicenseHeaders[] 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 (AddLicenseHeaders c : AddLicenseHeaders.values())
    System.out.println(c);

Returns:

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

valueOf

public static AddLicenseHeaders 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

getValuesForHelp

public static String getValuesForHelp()

Returns:

pretty-printed list of all available options.