Package uk.gov.gchq.gaffer.data.element

Enum IdentifierType

java.lang.Object

java.lang.Enum<IdentifierType>

uk.gov.gchq.gaffer.data.element.IdentifierType

All Implemented Interfaces:

Serializable, Comparable<IdentifierType>

public enum IdentifierType
extends Enum<IdentifierType>

The IdentifierType enum contains the identifier types used for Entitys and Edges.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADJACENT_MATCHED_VERTEX	The vertex adjacent to Edge's matched vertex (defaults to DESTINATION).
DESTINATION	An Edge's destination vertex
DIRECTED	An Edge's directed flag
GROUP	The element Group.
MATCHED_VERTEX	An Edge's matched vertex (defaults to SOURCE).
SOURCE	An Edge's source vertex
VERTEX	The vertex associated with an Entity.

Method Summary

Modifier and Type	Method	Description
static IdentifierType	fromName(String name)
static IdentifierType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IdentifierType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VERTEX

public static final IdentifierType VERTEX

The vertex associated with an Entity.

SOURCE

public static final IdentifierType SOURCE

An Edge's source vertex

DESTINATION

public static final IdentifierType DESTINATION

An Edge's destination vertex

DIRECTED

public static final IdentifierType DIRECTED

An Edge's directed flag

MATCHED_VERTEX

public static final IdentifierType MATCHED_VERTEX

An Edge's matched vertex (defaults to SOURCE).

ADJACENT_MATCHED_VERTEX

public static final IdentifierType ADJACENT_MATCHED_VERTEX

The vertex adjacent to Edge's matched vertex (defaults to DESTINATION).

GROUP

public static final IdentifierType GROUP

The element Group.

Method Detail

values

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

Returns:

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

valueOf

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

fromName

public static IdentifierType fromName(String name)