Package org.openmuc.jeebus.spine.api

Enum PresenceIndication

java.lang.Object

java.lang.Enum<PresenceIndication>

org.openmuc.jeebus.spine.api.PresenceIndication

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PresenceIndication>

public enum PresenceIndication
extends java.lang.Enum<PresenceIndication>

In the SPINE protocol or the Use Case specifications, data is normally marked with presence indicators marking whether the data is MANDATORY, RECOMMENDED or OPTIONAL.

Refer to the "General presence indication definitions" chapters in the specifications for further information.

Enum Constant Summary

Enum Constants

Enum Constant	Description
MANDATORY	Abbreviation in Specifications: M Requirement Keyword: SHALL
OPTIONAL	Abbreviation in Specifications: O Requirement Keyword: MAY
RECOMMENDED	Abbreviation in Specifications: R Requirement Keyword: SHOULD

Method Summary

Modifier and Type	Method	Description
static PresenceIndication	min(PresenceIndication left, PresenceIndication right)
static PresenceIndication	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static PresenceIndication[]	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

OPTIONAL

public static final PresenceIndication OPTIONAL

Abbreviation in Specifications: O
Requirement Keyword: MAY

RECOMMENDED

public static final PresenceIndication RECOMMENDED

Abbreviation in Specifications: R
Requirement Keyword: SHOULD

MANDATORY

public static final PresenceIndication MANDATORY

Abbreviation in Specifications: M
Requirement Keyword: SHALL

Method Detail

values

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

Returns:

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

valueOf

public static PresenceIndication valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

min

public static PresenceIndication min(PresenceIndication left,
                                     PresenceIndication right)