com.asakusafw.operator.model

Enum OperatorDescription.Reference.Kind

java.lang.Object

java.lang.Enum<OperatorDescription.Reference.Kind>

com.asakusafw.operator.model.OperatorDescription.Reference.Kind

All Implemented Interfaces:

Serializable, Comparable<OperatorDescription.Reference.Kind>

Enclosing class:

OperatorDescription.Reference

public static enum OperatorDescription.Reference.Kind
extends Enum<OperatorDescription.Reference.Kind>

Represents kind of references.

Enum Constant Summary

Enum Constants

Enum Constant and Description
METHOD Represents method declaration, or synopsis block in documentation comment.
PARAMETER Represents a method parameter, or parameter block in documentation comment.
RETURN Represents a method return type, or return block in documentation comment.
SPECIAL Represents an operator specific reference.

Method Summary

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

METHOD

public static final OperatorDescription.Reference.Kind METHOD

Represents method declaration, or synopsis block in documentation comment.

PARAMETER

public static final OperatorDescription.Reference.Kind PARAMETER

Represents a method parameter, or parameter block in documentation comment.

RETURN

public static final OperatorDescription.Reference.Kind RETURN

Represents a method return type, or return block in documentation comment.

SPECIAL

public static final OperatorDescription.Reference.Kind SPECIAL

Represents an operator specific reference.

Method Detail

values

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

Returns:

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

valueOf

public static OperatorDescription.Reference.Kind 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