y.io.graphml
Class KeyScope

java.lang.Object
  y.io.graphml.KeyScope

All Implemented Interfaces:

java.lang.Comparable

public final class KeyScope
extends java.lang.Object
implements java.lang.Comparable

Enumeration for the possible scopes of a graphml attribute.

Field Summary

static KeyScope	ALL Scope type all.
static KeyScope	EDGE Scope type edge.
static KeyScope	GRAPH Scope type graph.
static KeyScope	GRAPHML Scope type graphml.
static KeyScope	NODE Scope type node.
static KeyScope	PORT Scope type port.

Method Summary

int	compareTo(java.lang.Object o)
static java.util.Collection	getValues() Returns all declared scope type constants.
java.lang.String	name() Returns the name of this scope type constant, exactly as specified in the constant declaration.
java.lang.String	toString() Returns the name of this scope type constant.
static KeyScope	valueOf(java.lang.String value) Returns the enum constant for the enum type with the specified name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ALL

public static final KeyScope ALL

Scope type all.

NODE

public static final KeyScope NODE

Scope type node.

EDGE

public static final KeyScope EDGE

Scope type edge.

GRAPH

public static final KeyScope GRAPH

Scope type graph.

PORT

public static final KeyScope PORT

Scope type port.

GRAPHML

public static final KeyScope GRAPHML

Scope type graphml.

Method Detail

toString

public java.lang.String toString()

Returns the name of this scope type constant.

Overrides:

toString in class java.lang.Object

Returns:

the name of this scope type constant.

See Also:

name()

getValues

public static java.util.Collection getValues()

Returns all declared scope type constants. I.e. {ALL, EDGE, GRAPH, GRAPHML, NODE, PORT}.

Returns:

a collection holding all declared scope type constants.

name

public java.lang.String name()

Returns the name of this scope type constant, exactly as specified in the constant declaration. Scope type names are all uppercase.

Returns:

the name of this scope type constant.

See Also:

valueOf(String)

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

valueOf

public static KeyScope valueOf(java.lang.String value)

Returns the enum constant for the enum type with the specified name. Note, scope type names are all uppercase.

Parameters:

value - the name of the enum constant to return. Should be one of ALL, EDGE, GRAPH, GRAPHML, NODE, and PORT.

Returns:

The enum constant for the enum type with the specified name.

Throws:

java.lang.NullPointerException - if value is null.

java.lang.IllegalArgumentException - if value does not the name of a declared scope type constant.

See Also:

name()