Package adams.core

Enum License

java.lang.Object

java.lang.Enum<License>

adams.core.License

All Implemented Interfaces:

Serializable, Comparable<License>

public enum License
extends Enum<License>

Enumeration of software licenses.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Enum Constant Summary

Enum Constants

Enum Constant	Description
APACHE2	Apache 2.0.
BSD2	BSD 2-clause.
BSD3	BSD 3-clause.
CC_BY_25	CC BY 2.5.
CC_BY_3	CC BY 3.0.
CC_BY_4	CC BY 3.0.
CC_BY_NC_SA_25	CC BY-NC-SA 2.5.
CC_BY_NC_SA_3	CC BY-NC-SA 3.0.
CC_BY_NC_SA_4	CC BY-NC-SA 4.0.
CC_BY_SA_25	CC BY-SA 2.5.
CC_BY_SA_3	CC BY-SA 3.0.
CC_BY_SA_4	CC BY-SA 4.0.
CC_PD	CC public domain.
GPL2	GPL 2.
GPL3	GPL 3.
LGPL21	LGPL 2.1.
LGPL3	LGPL 2.1.
MIT	MIT.
PROPRIETARY	PROPRIETARY.
PUBLIC_DOMAIN	Public domain, i.e., AS IS.
TODO	to be determined.
UNKNOWN	UNKNOWN.

Method Summary

Modifier and Type	Method	Description
License	parse(String s)	Parses the given string and returns the associated enum.
String	toDisplay()	Returns the display string.
String	toRaw()	Returns the raw enum string.
String	toString()	Returns the display string.
static String	toString(AbstractOption option, Object object)	Returns the enum as string.
static License	valueOf(AbstractOption option, String str)	Returns an enum generated from the string.
static License	valueOf(String name)	Returns the enum constant of this type with the specified name.
static License[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final License UNKNOWN

UNKNOWN.

PROPRIETARY

public static final License PROPRIETARY

PROPRIETARY.

TODO

public static final License TODO

to be determined.

PUBLIC_DOMAIN

public static final License PUBLIC_DOMAIN

Public domain, i.e., AS IS.

APACHE2

public static final License APACHE2

Apache 2.0.

BSD2

public static final License BSD2

BSD 2-clause.

BSD3

public static final License BSD3

BSD 3-clause.

CC_PD

public static final License CC_PD

CC public domain.

CC_BY_25

public static final License CC_BY_25

CC BY 2.5.

CC_BY_3

public static final License CC_BY_3

CC BY 3.0.

CC_BY_4

public static final License CC_BY_4

CC BY 3.0.

CC_BY_SA_25

public static final License CC_BY_SA_25

CC BY-SA 2.5.

CC_BY_SA_3

public static final License CC_BY_SA_3

CC BY-SA 3.0.

CC_BY_SA_4

public static final License CC_BY_SA_4

CC BY-SA 4.0.

CC_BY_NC_SA_25

public static final License CC_BY_NC_SA_25

CC BY-NC-SA 2.5.

CC_BY_NC_SA_3

public static final License CC_BY_NC_SA_3

CC BY-NC-SA 3.0.

CC_BY_NC_SA_4

public static final License CC_BY_NC_SA_4

CC BY-NC-SA 4.0.

GPL2

public static final License GPL2

GPL 2.

GPL3

public static final License GPL3

GPL 3.

LGPL21

public static final License LGPL21

LGPL 2.1.

LGPL3

public static final License LGPL3

LGPL 2.1.

MIT

public static final License MIT

MIT.

Method Detail

values

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

Returns:

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

valueOf

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

toDisplay

public String toDisplay()

Returns the display string.

Returns:

the display string

toRaw

public String toRaw()

Returns the raw enum string.

Returns:

the raw enum string

toString

public String toString()

Returns the display string.

Overrides:

toString in class Enum<License>

Returns:

the display string

parse

public License parse(String s)

Parses the given string and returns the associated enum.

Parameters:

s - the string to parse

Returns:

the enum or null if not found

toString

public static String toString(AbstractOption option,
                              Object object)

Returns the enum as string.

Parameters:

option - the current option

object - the enum object to convert

Returns:

the generated string

valueOf

public static License valueOf(AbstractOption option,
                              String str)

Returns an enum generated from the string.

Parameters:

option - the current option

str - the string to convert to an enum

Returns:

the generated enum or null in case of error