org.opencypher.tools.xml

Enum Comment

java.lang.Object

java.lang.Enum<Comment>

org.opencypher.tools.xml.Comment

All Implemented Interfaces:

Serializable, Comparable<Comment>

public enum Comment
extends Enum<Comment>

Marker, used together with the @Child(Comment.class) annotation to mark that the annotated text method accepts comments rather than regular text elements.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Comment.Header

Method Summary

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

Method Detail

values

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

Returns:

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

valueOf

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