Package de.xima.fc.common.graphdot

Enum EOrdering

java.lang.Object

java.lang.Enum<EOrdering>

de.xima.fc.common.graphdot.EOrdering

All Implemented Interfaces:

Serializable, CharSequence, Comparable<EOrdering>

public enum EOrdering
extends Enum<EOrdering>

Enumeration for the values of the ordering attribute, which constrains the left-to-right ordering of node edges.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
IN	The in-edges of a node must appear left-to-right in the same order in which they are defined in the input.
OUT	The out-edges of a node, that is, edges with the node as its tail node, must appear left-to-right in the same order in which they are defined in the input.

Method Summary

Modifier and Type	Method	Description
default char	charAt(int index)
default IntStream	chars()
default IntStream	codePoints()
boolean	equals(Object obj)
String	getOrderingName()	Gets the name of the ordering as used in a graphviz dot file.
int	hashCode()
default int	length()
default CharSequence	subSequence(int start, int end)
String	toString()
static EOrdering	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EOrdering[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IN

public static final EOrdering IN

The in-edges of a node must appear left-to-right in the same order in which they are defined in the input.

OUT

public static final EOrdering OUT

The out-edges of a node, that is, edges with the node as its tail node, must appear left-to-right in the same order in which they are defined in the input.

Method Detail

values

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

Returns:

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

valueOf

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

getOrderingName

public String getOrderingName()

Gets the name of the ordering as used in a graphviz dot file.

Returns:

The name of the ordering as used in a graphviz dot file.

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Enum<EOrdering>

charAt

public default char charAt(int index)

Specified by:

charAt in interface CharSequence

chars

public default IntStream chars()

Specified by:

chars in interface CharSequence

codePoints

public default IntStream codePoints()

Specified by:

codePoints in interface CharSequence

equals

public abstract boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object

length

public default int length()

Specified by:

length in interface CharSequence

subSequence

public default CharSequence subSequence(int start,
                                        int end)

Specified by:

subSequence in interface CharSequence