org.phenotips.consents

Enum ConsentStatus

java.lang.Object

java.lang.Enum<ConsentStatus>

org.phenotips.consents.ConsentStatus

All Implemented Interfaces:

Serializable, Comparable<ConsentStatus>

public enum ConsentStatus
extends Enum<ConsentStatus>

Used to indicate the status of a consent, which is not limited to 'granted'/'not granted'.

Since:

1.3M1

Version:

$Id: 2ecf32cb3880a6a6eff2012a116838a2762972a1 $

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO Used when a consent is not granted.
NOT_SET Used for when a consent instance has just been loaded, and has no status.
YES Used when a consent is granted.

Method Summary

Modifier and Type	Method and Description
static ConsentStatus	fromString(String string) For converting a string into this Enum.
String	toString()
static ConsentStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConsentStatus[]	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

NOT_SET

public static final ConsentStatus NOT_SET

Used for when a consent instance has just been loaded, and has no status.

YES

public static final ConsentStatus YES

Used when a consent is granted.

NO

public static final ConsentStatus NO

Used when a consent is not granted.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<ConsentStatus>

fromString

public static ConsentStatus fromString(String string)

For converting a string into this Enum.

Parameters:

string - which corresponds to one of this enum values

Returns:

corresponding enum