Package org.odpi.openmetadata.viewservices.assetcatalog.beans

Enum Class Scope

java.lang.Object

java.lang.Enum<Scope>

org.odpi.openmetadata.viewservices.assetcatalog.beans.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>, Constable

public enum Scope
extends Enum<Scope>

Scope characterizes the type of lineage query 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
END_TO_END	end-to-end
ULTIMATE_DESTINATION	ultimate-destination
ULTIMATE_SOURCE	ultimate-source
VERTICAL	vertical

Method Summary

Modifier and Type	Method	Description
static Scope	fromString(String text)	Convert a string to an enum value - or null if no match occurs.
String	getValue()	Retrieve the enum value as a string.
static Scope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Scope[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

END_TO_END

public static final Scope END_TO_END

end-to-end

ULTIMATE_SOURCE

public static final Scope ULTIMATE_SOURCE

ultimate-source

ULTIMATE_DESTINATION

public static final Scope ULTIMATE_DESTINATION

ultimate-destination

VERTICAL

public static final Scope VERTICAL

vertical

Method Details

values

public static Scope[] 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 Scope 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

getValue

public String getValue()

Retrieve the enum value as a string.

Returns:

string

fromString

public static Scope fromString(String text)

Convert a string to an enum value - or null if no match occurs.

Parameters:

text - string, typically passed on a REST call

Returns:

associated enum