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

Enum DirectedType

java.lang.Object

java.lang.Enum<DirectedType>

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

All Implemented Interfaces:

Serializable, Comparable<DirectedType>

public enum DirectedType
extends Enum<DirectedType>

A DirectedType defines whether edges should be directed, undirected or either/both.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DIRECTED
EITHER	Edges are either DIRECTED or UNDIRECTED.
UNDIRECTED

Method Summary

Modifier and Type	Method	Description
static DirectedType	and(DirectedType dirType1, DirectedType dirType2)
static boolean	areCompatible(DirectedType dirType1, DirectedType dirType2)
boolean	isDirected()
static boolean	isDirected(DirectedType directedType)
static boolean	isEither(DirectedType directedType)
boolean	isUndirected()
static boolean	isUndirected(DirectedType directedType)
static DirectedType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DirectedType[]	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

EITHER

public static final DirectedType EITHER

Edges are either DIRECTED or UNDIRECTED. This is the default value.

DIRECTED

public static final DirectedType DIRECTED

UNDIRECTED

public static final DirectedType UNDIRECTED

Method Detail

values

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

Returns:

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

valueOf

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

isEither

public static boolean isEither(DirectedType directedType)

isDirected

public static boolean isDirected(DirectedType directedType)

isUndirected

public static boolean isUndirected(DirectedType directedType)

areCompatible

public static boolean areCompatible(DirectedType dirType1,
                                    DirectedType dirType2)

and

public static DirectedType and(DirectedType dirType1,
                               DirectedType dirType2)

isDirected

public boolean isDirected()

isUndirected

public boolean isUndirected()