org.apache.creadur.whisker.app

Enum LicenseConfiguration

java.lang.Object

java.lang.Enum<LicenseConfiguration>

org.apache.creadur.whisker.app.LicenseConfiguration

All Implemented Interfaces:

Serializable, Comparable<LicenseConfiguration>

public enum LicenseConfiguration
extends Enum<LicenseConfiguration>

Enumerates

Enum Constant Summary

Enum Constants

Enum Constant and Description
INCLUDE_SOURCE_URLS Include source URLs in the LICENSE (as well as the NOTICE)
MINIMAL The essentials only.

Field Summary

Fields

Modifier and Type	Field and Description
static LicenseConfiguration	DEFAULT_LICENSE_CONFIGURATION Default to include source URLs.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	includeSourceUrlsInLicense() Should source URLs be included in the LICENSE?
static LicenseConfiguration	notNull(LicenseConfiguration configuration) Replaces null with DEFAULT_LICENSE_CONFIGURATION.
static LicenseConfiguration	valueOf(String name) Returns the enum constant of this type with the specified name.
static LicenseConfiguration[]	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

INCLUDE_SOURCE_URLS

public static final LicenseConfiguration INCLUDE_SOURCE_URLS

Include source URLs in the LICENSE (as well as the NOTICE)

MINIMAL

public static final LicenseConfiguration MINIMAL

The essentials only.

Field Detail

DEFAULT_LICENSE_CONFIGURATION

public static LicenseConfiguration DEFAULT_LICENSE_CONFIGURATION

Default to include source URLs.

Method Detail

values

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

Returns:

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

valueOf

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

notNull

public static LicenseConfiguration notNull(LicenseConfiguration configuration)

Replaces null with DEFAULT_LICENSE_CONFIGURATION.

Parameters:

configuration - possibly null

Returns:

not null

includeSourceUrlsInLicense

public boolean includeSourceUrlsInLicense()

Should source URLs be included in the LICENSE?

Returns:

true when source URLs should be included, false otherwise