org.odpi.openmetadata.repositoryservices.events

Enum OMRSEventDirection

java.lang.Object

java.lang.Enum<OMRSEventDirection>

org.odpi.openmetadata.repositoryservices.events.OMRSEventDirection

All Implemented Interfaces:

Serializable, Comparable<OMRSEventDirection>

public enum OMRSEventDirection
extends Enum<OMRSEventDirection>
implements Serializable

OMRSEventDirection defines the origin of an OMRSEvent. It is used primarily for logging and debug.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INBOUND
OUTBOUND
UNKNOWN

Method Summary

Modifier and Type	Method and Description
String	getDescription() Return the default description for the enum, used when there is not natural language resource bundle available.
String	getName() Return the name for the enum, used for message content.
int	getOrdinal() Return the identifier for the enum, used for indexing arrays etc with the enum.
String	toString() toString() JSON-style
static OMRSEventDirection	valueOf(String name) Returns the enum constant of this type with the specified name.
static OMRSEventDirection[]	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 OMRSEventDirection UNKNOWN

INBOUND

public static final OMRSEventDirection INBOUND

OUTBOUND

public static final OMRSEventDirection OUTBOUND

Method Detail

values

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

Returns:

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

valueOf

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

getOrdinal

public int getOrdinal()

Return the identifier for the enum, used for indexing arrays etc with the enum.

Returns:

int identifier

getName

public String getName()

Return the name for the enum, used for message content.

Returns:

String name

getDescription

public String getDescription()

Return the default description for the enum, used when there is not natural language resource bundle available.

Returns:

String default description

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<OMRSEventDirection>

Returns:

string description