Package org.odpi.openmetadata.frameworks.openmetadata.refdata

Enum Class AssociationType

java.lang.Object

java.lang.Enum<AssociationType>

org.odpi.openmetadata.frameworks.openmetadata.refdata.AssociationType

All Implemented Interfaces:

Serializable, Comparable<AssociationType>, Constable

public enum AssociationType
extends Enum<AssociationType>

AssociationType defines the type of association between two valid values, such as 'containment', 'aggregation' or 'inheritance.'.

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
AGGREGATION
CONTAINMENT
DEPENDENCY
INHERITANCE
USES

Method Summary

Modifier and Type	Method	Description
String	getCategory()	Return the category for this value.
String	getDescription()	Return the default description of the enumeration.
String	getDescriptionGUID()	Return the unique identifier for the valid value that represents the enum value.
String	getName()	Return the default name of the enumeration.
int	getOrdinal()	Return the numeric representation of the enumeration.
String	getQualifiedName()	Return the qualified name for this value.
boolean	isDefault()	Return whether the enum is the default value or not.
String	toString()	toString() JSON-style
static AssociationType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AssociationType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CONTAINMENT

public static final AssociationType CONTAINMENT

AGGREGATION

public static final AssociationType AGGREGATION

INHERITANCE

public static final AssociationType INHERITANCE

DEPENDENCY

public static final AssociationType DEPENDENCY

USES

public static final AssociationType USES

Method Details

values

public static AssociationType[] 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 AssociationType 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 numeric representation of the enumeration.

Returns:

int ordinal

getName

public String getName()

Return the default name of the enumeration.

Returns:

String name

getDescription

public String getDescription()

Return the default description of the enumeration.

Returns:

String description

getDescriptionGUID

public String getDescriptionGUID()

Return the unique identifier for the valid value that represents the enum value.

Returns:

guid

getQualifiedName

public String getQualifiedName()

Return the qualified name for this value.

Returns:

string

getCategory

public String getCategory()

Return the category for this value.

Returns:

string

isDefault

public boolean isDefault()

Return whether the enum is the default value or not.

Returns:

boolean

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<AssociationType>

Returns:

string description