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

Class ApiParameterConfig

java.lang.Object

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

public class ApiParameterConfig
extends java.lang.Object

Configuration for a single parameter of a Swarm Endpoint method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiParameterConfig.Classification Classification of how the parameter is used within Endpoints method calls.

Constructor Summary

Constructors

Constructor and Description
ApiParameterConfig(ApiMethodConfig apiMethodConfig, java.lang.String name, java.lang.String description, boolean nullable, java.lang.String defaultValue, com.google.common.reflect.TypeToken<?> type, TypeLoader typeLoader)
ApiParameterConfig(ApiParameterConfig original, ApiMethodConfig apiMethodConfig)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
ApiMethodConfig	getApiMethodConfig()
ApiParameterConfig.Classification	getClassification() Generates an API parameter classifcation based on the type.
java.lang.String	getDefaultValue()
java.lang.String	getDescription()
java.lang.String	getName()
boolean	getNullable()
com.google.common.reflect.TypeToken<?>	getRepeatedItemSerializedType() If the serialized type of the parameter is a repeated type, returns the serialized individual item type.
java.util.List<java.lang.Class<? extends Transformer<?,?>>>	getRepeatedItemSerializers() If the serialized type of the parameter is a repeated type, returns the serializer to be used on each individual item.
com.google.common.reflect.TypeToken<?>	getRepeatedItemType() If the serialized type of the parameter is a repeated type, returns the individual item type.
com.google.common.reflect.TypeToken<?>	getSchemaBaseType() Gets the type that acts as the source for schema generation.
java.util.List<java.lang.Class<? extends Transformer<?,?>>>	getSerializers()
com.google.common.reflect.TypeToken<?>	getType()
int	hashCode()
boolean	isEnum()
boolean	isRepeated()
void	setRepeatedItemSerializer(java.lang.Class<? extends Transformer<?,?>> repeatedItemSerializer)
void	setSerializer(java.lang.Class<? extends Transformer<?,?>> serializer)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiParameterConfig

public ApiParameterConfig(ApiMethodConfig apiMethodConfig,
                          java.lang.String name,
                          java.lang.String description,
                          boolean nullable,
                          java.lang.String defaultValue,
                          com.google.common.reflect.TypeToken<?> type,
                          TypeLoader typeLoader)

ApiParameterConfig

public ApiParameterConfig(ApiParameterConfig original,
                          ApiMethodConfig apiMethodConfig)

Method Detail

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getApiMethodConfig

public ApiMethodConfig getApiMethodConfig()

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getNullable

public boolean getNullable()

getDefaultValue

public java.lang.String getDefaultValue()

getType

public com.google.common.reflect.TypeToken<?> getType()

getRepeatedItemType

public com.google.common.reflect.TypeToken<?> getRepeatedItemType()

If the serialized type of the parameter is a repeated type, returns the individual item type. Otherwise returns null.

isRepeated

public boolean isRepeated()

Returns:

true iff the serialized type of the parameter is a repeated type.

isEnum

public boolean isEnum()

Returns:

true iff the serialized type (or serialized item type) of the parameter is an enum type.

getSerializers

public java.util.List<java.lang.Class<? extends Transformer<?,?>>> getSerializers()

Returns:

The serializer to be used on the parameter.

setSerializer

public void setSerializer(java.lang.Class<? extends Transformer<?,?>> serializer)

getRepeatedItemSerializers

public java.util.List<java.lang.Class<? extends Transformer<?,?>>> getRepeatedItemSerializers()

If the serialized type of the parameter is a repeated type, returns the serializer to be used on each individual item. Otherwise returns null.

setRepeatedItemSerializer

public void setRepeatedItemSerializer(java.lang.Class<? extends Transformer<?,?>> repeatedItemSerializer)

getSchemaBaseType

public com.google.common.reflect.TypeToken<?> getSchemaBaseType()

Gets the type that acts as the source for schema generation. In the case of resource serialization, the schema is based on the type being serialized. Simple serializers just convert from one type to another, in which case the schema would be derived from the target type instead.

getRepeatedItemSerializedType

public com.google.common.reflect.TypeToken<?> getRepeatedItemSerializedType()

If the serialized type of the parameter is a repeated type, returns the serialized individual item type. Otherwise returns null.

getClassification

public ApiParameterConfig.Classification getClassification()

Generates an API parameter classifcation based on the type.