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

Enum ElementId.Matches

java.lang.Object

java.lang.Enum<ElementId.Matches>

uk.gov.gchq.gaffer.data.element.id.ElementId.Matches

All Implemented Interfaces:

Serializable, Comparable<ElementId.Matches>

Enclosing interface:

ElementId

public static enum ElementId.Matches
extends Enum<ElementId.Matches>

Enumerated type to denote which component of an Element matches an input parameter.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTH	Matches both the source and destination of an Edge.
DESTINATION	Matches the destination of an Edge
NONE	Matches nothing.
SOURCE	Matches the source of an Edge
VERTEX	Matches the vertex of an Entity

Method Summary

Modifier and Type	Method	Description
boolean	isDestination()
boolean	isIdentifier()
boolean	isMatch()
boolean	isSource()
static ElementId.Matches	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ElementId.Matches[]	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

BOTH

public static final ElementId.Matches BOTH

Matches both the source and destination of an Edge.

VERTEX

public static final ElementId.Matches VERTEX

Matches the vertex of an Entity

SOURCE

public static final ElementId.Matches SOURCE

Matches the source of an Edge

DESTINATION

public static final ElementId.Matches DESTINATION

Matches the destination of an Edge

NONE

public static final ElementId.Matches NONE

Matches nothing.

Method Detail

values

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

Returns:

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

valueOf

public static ElementId.Matches 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

isIdentifier

public boolean isIdentifier()

isSource

public boolean isSource()

isDestination

public boolean isDestination()

isMatch

public boolean isMatch()