com.groiss.dms

Enum DMSNote.Type

java.lang.Object

java.lang.Enum<DMSNote.Type>

com.groiss.dms.DMSNote.Type

All Implemented Interfaces:

DefinedEnum, Serializable, Comparable<DMSNote.Type>

Enclosing interface:

DMSNote

public static enum DMSNote.Type
extends Enum<DMSNote.Type>
implements DefinedEnum

Defines the various types of a note

Enum Constant Summary

Enum Constants

Enum Constant and Description
PRIVATE A note that is marked as private
STANDARD Default value for all notes
SYSTEM Determines that the note has been created by the system and not by a user

Method Summary

Modifier and Type	Method and Description
Short	definedValue() Get the fixed value for this DefinedEnum.
static DMSNote.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static DMSNote.Type[]	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

STANDARD

public static final DMSNote.Type STANDARD

Default value for all notes

PRIVATE

public static final DMSNote.Type PRIVATE

A note that is marked as private

SYSTEM

public static final DMSNote.Type SYSTEM

Determines that the note has been created by the system and not by a user

Method Detail

values

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

Returns:

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

valueOf

public static DMSNote.Type 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

definedValue

public Short definedValue()

Description copied from interface: DefinedEnum

Get the fixed value for this DefinedEnum. At the moment, Strings, Shorts, Integers and Longs are supported.

Specified by:

definedValue in interface DefinedEnum

Returns:

the fixed value