com.google.api.tools.framework.aspects.http.model

Class RestMethod

java.lang.Object

com.google.api.tools.framework.model.Element

com.google.api.tools.framework.aspects.http.model.RestMethod

public class RestMethod
extends Element

Encapsulates information about a REST method derived from an RPC method. Each HttpAttribute has a REST method associated with it.

Method Summary

Modifier and Type	Method and Description
static RestMethod	create(Method method, RestKind kind, java.lang.String collectionName, java.lang.String customMethodName) Create a new REST method.
Method	getBaseMethod() Returns the underlying method element.
java.lang.String	getFullName() Returns a fully qualified name for the element.
TypeRef	getInputType() Get the input type of the underlying method.
Location	getLocation() Returns the location associated with this element.
Model	getModel() Returns the model associated with this element.
TypeRef	getOutputType() Get the output type of the underlying method.
static RestMethod	getPrimaryRestMethod(Method method) Delivers the primary REST method associated with the given RPC method.
java.lang.String	getRestCollectionName() Returns the rest collection name.
java.lang.String	getRestCollectionNameNoVersion() Returns the rest collection name without version prefix.
java.lang.String	getRestCustomMethodName() Returns the rest custom method name.
java.lang.String	getRestFullMethodName() Returns the full REST method name.
java.lang.String	getRestFullMethodNameNoVersion() Returns the full rest name without the version string.
RestKind	getRestKind() Returns the rest kind.
java.lang.String	getRestMethodName() Returns the rest method name.
java.lang.String	getSimpleName() Returns a simple name for the element.
java.lang.String	getSimpleRestCollectionName() Returns the rest collection name.
java.lang.String	getVersionWithDefault() Returns the full name with version prefix stripped if the full name has it.
boolean	isReachable() Returns if the rest method reachable with current scoper.
void	setRestCollectionName(java.lang.String restCollectionName) Sets the rest collection name.
void	setRestCustomMethodName(java.lang.String restCustomMethodName) Sets the rest custom method name.
void	setRestKind(RestKind kind) Sets the rest kind.
java.lang.String	toString()

Methods inherited from class com.google.api.tools.framework.model.Element

addAttribute, getAttribute, getAttributeOrDefault, hasAttribute, putAttribute, removeAttribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

create

public static RestMethod create(Method method,
                                RestKind kind,
                                java.lang.String collectionName,
                                java.lang.String customMethodName)

Create a new REST method.

getPrimaryRestMethod

@Nullable
public static RestMethod getPrimaryRestMethod(Method method)

Delivers the primary REST method associated with the given RPC method. Returns null if the method has no HTTP attribute.

getLocation

public Location getLocation()

Description copied from class: Element

Returns the location associated with this element.

Specified by:

getLocation in class Element

getModel

public Model getModel()

Description copied from class: Element

Returns the model associated with this element.

Specified by:

getModel in class Element

getFullName

public java.lang.String getFullName()

Description copied from class: Element

Returns a fully qualified name for the element.

Specified by:

getFullName in class Element

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getSimpleName

public java.lang.String getSimpleName()

Description copied from class: Element

Returns a simple name for the element.

Specified by:

getSimpleName in class Element

getInputType

public TypeRef getInputType()

Get the input type of the underlying method.

getOutputType

public TypeRef getOutputType()

Get the output type of the underlying method.

getBaseMethod

public Method getBaseMethod()

Returns the underlying method element.

getRestFullMethodName

public java.lang.String getRestFullMethodName()

Returns the full REST method name.

getRestFullMethodNameNoVersion

public java.lang.String getRestFullMethodNameNoVersion()

Returns the full rest name without the version string.

isReachable

public boolean isReachable()

Returns if the rest method reachable with current scoper.

getRestMethodName

public java.lang.String getRestMethodName()

Returns the rest method name.

getRestCustomMethodName

public java.lang.String getRestCustomMethodName()

Returns the rest custom method name.

getRestKind

public RestKind getRestKind()

Returns the rest kind.

getRestCollectionName

public java.lang.String getRestCollectionName()

Returns the rest collection name.

getSimpleRestCollectionName

public java.lang.String getSimpleRestCollectionName()

Returns the rest collection name.

getRestCollectionNameNoVersion

public java.lang.String getRestCollectionNameNoVersion()

Returns the rest collection name without version prefix. Returns empty if there is no collection specified in the rest method.

setRestKind

public void setRestKind(RestKind kind)

Sets the rest kind.

setRestCustomMethodName

public void setRestCustomMethodName(java.lang.String restCustomMethodName)

Sets the rest custom method name.

setRestCollectionName

public void setRestCollectionName(java.lang.String restCollectionName)

Sets the rest collection name.

getVersionWithDefault

public java.lang.String getVersionWithDefault()

Returns the full name with version prefix stripped if the full name has it.