Package org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs

Enum Class RelationshipEndCardinality

java.lang.Object

java.lang.Enum<RelationshipEndCardinality>

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.RelationshipEndCardinality

All Implemented Interfaces:

Serializable, Comparable<RelationshipEndCardinality>, Constable

public enum RelationshipEndCardinality
extends Enum<RelationshipEndCardinality>
implements Serializable

RelationshipCardinality is used in a RelationshipEndDef to indicate how many relationships of this type can be connected to an entity instance.:

• UNKNOWN: uninitialized cardinality.
• AT_MOST_ONE: means there can be zero or one instances of this relationship connected to an instance of the EntityDef. This relationship is written as 0..1 in UML.
• ANY_NUMBER: means there can be none, one or many instances of this relationship connected to an instance of the EntityDef. This relationship is often written as 0..* or * in UML.

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
ANY_NUMBER	Any Number (0..* or * for any number of instances).
AT_MOST_ONE	At Most One (0..1 for zero or one instances).
UNKNOWN	Unknown or uninitialized cardinality.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description of the cardinality.
String	getName()	Return the default name of the cardinality.
int	getOrdinal()	Return the numeric representation of the cardinality.
String	toString()	toString() JSON-style
static RelationshipEndCardinality	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RelationshipEndCardinality[]	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

UNKNOWN

public static final RelationshipEndCardinality UNKNOWN

Unknown or uninitialized cardinality.

AT_MOST_ONE

public static final RelationshipEndCardinality AT_MOST_ONE

At Most One (0..1 for zero or one instances).

ANY_NUMBER

public static final RelationshipEndCardinality ANY_NUMBER

Any Number (0..* or * for any number of instances).

Method Details

values

public static RelationshipEndCardinality[] 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 RelationshipEndCardinality 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 cardinality.

Returns:

int ordinal

getName

public String getName()

Return the default name of the cardinality.

Returns:

String name

getDescription

public String getDescription()

Return the default description of the cardinality.

Returns:

String description

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<RelationshipEndCardinality>

Returns:

string description