Package de.xima.fc.common.graphdot

Enum EClusterMode

java.lang.Object

java.lang.Enum<EClusterMode>

de.xima.fc.common.graphdot.EClusterMode

All Implemented Interfaces:

Serializable, CharSequence, Comparable<EClusterMode>

public enum EClusterMode
extends Enum<EClusterMode>

Possible values for the clusterrank attribute.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
GLOBAL	Turns off the special cluster processing.
LOCAL	A subgraph whose name begins with cluster is given special treatment.
NONE	Turns off the special cluster processing.

Method Summary

Modifier and Type	Method	Description
default char	charAt(int index)
default IntStream	chars()
default IntStream	codePoints()
boolean	equals(Object obj)
String	getClusterMode()	Gets the name of this cluster mode, as it is used in dot files.
int	hashCode()
default int	length()
default CharSequence	subSequence(int start, int end)
String	toString()
static EClusterMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EClusterMode[]	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

GLOBAL

public static final EClusterMode GLOBAL

Turns off the special cluster processing. Note: from the docs: The modes clusterrank=global and clusterrank=none appear to be identical.

LOCAL

public static final EClusterMode LOCAL

A subgraph whose name begins with cluster is given special treatment. The subgraph is laid out separately, and then integrated as a unit into its parent graph, with a bounding rectangle drawn about it. If the cluster has a label parameter, this label is displayed within the rectangle. Note also that there can be clusters within clusters.

NONE

public static final EClusterMode NONE

Turns off the special cluster processing. Note: from the docs: The modes clusterrank=global and clusterrank=none appear to be identical.

Method Detail

values

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

Returns:

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

valueOf

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

getClusterMode

public String getClusterMode()

Gets the name of this cluster mode, as it is used in dot files.

Returns:

The name of this cluster mode, as it is used in dot files.

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Enum<EClusterMode>

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