com.tinkerpop.rexster.extension
Enum ExtensionApiBehavior

java.lang.Object
  extended by java.lang.Enum<ExtensionApiBehavior>
      extended by com.tinkerpop.rexster.extension.ExtensionApiBehavior
All Implemented Interfaces:
Serializable, Comparable<ExtensionApiBehavior>

public enum ExtensionApiBehavior
extends Enum<ExtensionApiBehavior>

Defines how the extension API information should be generated.


Enum Constant Summary
DEFAULT
          Generates the API from both the ExtensionDescriptor and ExtensionRequestParameters annotations, where the ExtensionRequestParameters override keys presented by the ExtensionDescriptor.
EXTENSION_DESCRIPTOR_ONLY
          Generates the API from the ExtensionDescriptor on the method only.
EXTENSION_PARAMETER_ONLY
          Generates the API from the ExtensionRequestParameter for each parameter in the method only.
 
Method Summary
static ExtensionApiBehavior valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ExtensionApiBehavior[] 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

EXTENSION_DESCRIPTOR_ONLY

public static final ExtensionApiBehavior EXTENSION_DESCRIPTOR_ONLY
Generates the API from the ExtensionDescriptor on the method only.


EXTENSION_PARAMETER_ONLY

public static final ExtensionApiBehavior EXTENSION_PARAMETER_ONLY
Generates the API from the ExtensionRequestParameter for each parameter in the method only.


DEFAULT

public static final ExtensionApiBehavior DEFAULT
Generates the API from both the ExtensionDescriptor and ExtensionRequestParameters annotations, where the ExtensionRequestParameters override keys presented by the ExtensionDescriptor.

Method Detail

values

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

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

valueOf

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


Copyright © 2009-2012. All Rights Reserved.