com.google.api.server.spi.config.model

Enum ApiParameterConfig.Classification

java.lang.Object

java.lang.Enum<ApiParameterConfig.Classification>

com.google.api.server.spi.config.model.ApiParameterConfig.Classification

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ApiParameterConfig.Classification>

Enclosing class:

ApiParameterConfig

public static enum ApiParameterConfig.Classification
extends java.lang.Enum<ApiParameterConfig.Classification>

Classification of how the parameter is used within Endpoints method calls.

Enum Constant Summary

Enum Constants

Enum Constant and Description
API_PARAMETER Parameter that will be filled by the value of an API parameter.
INJECTED Parameter that will be automatically injected by the SPI framework.
RESOURCE Parameter that will be filled with an API entity.
UNKNOWN Parameter that could not be classified because its type is unknown.

Method Summary

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

INJECTED

public static final ApiParameterConfig.Classification INJECTED

Parameter that will be automatically injected by the SPI framework.

API_PARAMETER

public static final ApiParameterConfig.Classification API_PARAMETER

Parameter that will be filled by the value of an API parameter. Generally used for simple values like an ID.

RESOURCE

public static final ApiParameterConfig.Classification RESOURCE

Parameter that will be filled with an API entity. Generally used for the resource object in REST-style APIs.

UNKNOWN

public static final ApiParameterConfig.Classification UNKNOWN

Parameter that could not be classified because its type is unknown.

Method Detail

values

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

Returns:

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

valueOf

public static ApiParameterConfig.Classification valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null