Package org.odpi.openmetadata.viewservices.assetcatalog.rest

Enum Class HierarchyType

java.lang.Object

java.lang.Enum<HierarchyType>

org.odpi.openmetadata.viewservices.assetcatalog.rest.HierarchyType

All Implemented Interfaces:

Serializable, Comparable<HierarchyType>, Constable

public enum HierarchyType
extends Enum<HierarchyType>

HierarchyType describes the direction of a lineage graph request.

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
ALL	All elements.
DOWNWARD	Downward elements from the graph.
UPWARD	Upward elements from the graph.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the description of the enum.
String	getName()	Return the display name of the enum.
int	getOrdinal()	Return the unique identifier of the enum.
String	toString()	Standard toString method.
static HierarchyType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HierarchyType[]	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

DOWNWARD

public static final HierarchyType DOWNWARD

Downward elements from the graph.

UPWARD

public static final HierarchyType UPWARD

Upward elements from the graph.

ALL

public static final HierarchyType ALL

All elements.

Method Details

values

public static HierarchyType[] 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 HierarchyType 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 unique identifier of the enum.

Returns:

int

getName

public String getName()

Return the display name of the enum.

Returns:

string

getDescription

public String getDescription()

Return the description of the enum.

Returns:

string

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<HierarchyType>

Returns:

print out of variables in a JSON-style