org.barfuin.texttree.api

Enum IdentityScheme

java.lang.Object

java.lang.Enum<IdentityScheme>

org.barfuin.texttree.api.IdentityScheme

All Implemented Interfaces:

Serializable, Comparable<IdentityScheme>

public enum IdentityScheme
extends Enum<IdentityScheme>

How the internal cycle detector should identify objects.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ByIdentity A node is identified by its Java object identity, so two nodes are considered to be the same node if they are actually the same Java object.
ByKey A node is identified by its key (getKey()), so two nodes are considered to be the same node if they have the key.
ByText A node is identified by the text that is being displayed for it (getText()), so two nodes are considered to be the same node if they have the same text.

Method Summary

Modifier and Type	Method and Description
static IdentityScheme	valueOf(String name) Returns the enum constant of this type with the specified name.
static IdentityScheme[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ByIdentity

public static final IdentityScheme ByIdentity

A node is identified by its Java object identity, so two nodes are considered to be the same node if they are actually the same Java object.

ByKey

public static final IdentityScheme ByKey

A node is identified by its key (getKey()), so two nodes are considered to be the same node if they have the key.

ByText

public static final IdentityScheme ByText

A node is identified by the text that is being displayed for it (getText()), so two nodes are considered to be the same node if they have the same text.

Method Detail

valueOf

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

values

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

Returns:

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