Package org.odpi.openmetadata.repositoryservices.events

Enum Class OMRSEventProtocolVersion

java.lang.Object

java.lang.Enum<OMRSEventProtocolVersion>

org.odpi.openmetadata.repositoryservices.events.OMRSEventProtocolVersion

All Implemented Interfaces:

Serializable, Comparable<OMRSEventProtocolVersion>, Constable

public enum OMRSEventProtocolVersion
extends Enum<OMRSEventProtocolVersion>
implements Serializable

OMRSEventProtocolVersion provides the identifier for the version number of the event payload. There is only one version at the moment which is why it looks a little sad.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
V1	OMRS Version 1

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description for the star rating for this enum instance.
String	getName()	Return the default symbol for this enum instance.
int	getOrdinal()	Return the code for this enum instance
String	toString()	Standard toString method.
static OMRSEventProtocolVersion	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OMRSEventProtocolVersion[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

V1

public static final OMRSEventProtocolVersion V1

OMRS Version 1

Method Details

values

public static OMRSEventProtocolVersion[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static OMRSEventProtocolVersion valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getOrdinal

public int getOrdinal()

Return the code for this enum instance

Returns:

int star rating code

getName

public String getName()

Return the default symbol for this enum instance.

Returns:

String default symbol

getDescription

public String getDescription()

Return the default description for the star rating for this enum instance.

Returns:

String default description

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<OMRSEventProtocolVersion>

Returns:

print out of variables in a JSON-style