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

Class CollectionAttribute

java.lang.Object

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

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

public class CollectionAttribute
extends Element

An object representing a REST collection, as derived from analyzing an Api's services and methods. A list of those attributes is attached to the model object.

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.inject.Key<java.util.List<CollectionAttribute>>	KEY The key to access the collections of the model.

Constructor Summary

Constructors

Constructor and Description
CollectionAttribute(Model model, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
RestMethod	addMethod(RestMethod method) Add method to collection.
java.lang.String	getFullName() Returns a fully qualified name for the element.
java.lang.String	getFullNameNoVersion() Returns the full name with version prefix stripped if the full name has it.
Location	getLocation() Returns the location associated with this element.
java.lang.Iterable<RestMethod>	getMethods() Returns the methods associated with this collection.
Model	getModel() Returns the model associated with this element.
CollectionAttribute	getParent() Returns the parent collection, or null if none.
com.google.common.collect.ImmutableList<RestMethod>	getReachableMethods() Returns the methods associated with this collection and reachable with the current scoper.
TypeRef	getResourceType() Returns the resource type, or null, if none assigned.
java.lang.String	getSimpleName() Returns a simple name for the element.
java.lang.String	getVersionWithDefault()
void	setParent(CollectionAttribute collection) Set parent collection.
void	setResourceType(TypeRef resourceType) Sets the resource type.

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, toString, wait, wait, wait

Field Detail

KEY

public static final com.google.inject.Key<java.util.List<CollectionAttribute>> KEY

The key to access the collections of the model.

Constructor Detail

CollectionAttribute

public CollectionAttribute(Model model,
                           java.lang.String name)

Method Detail

getModel

public Model getModel()

Description copied from class: Element

Returns the model associated with this element.

Specified by:

getModel in class Element

getLocation

public Location getLocation()

Description copied from class: Element

Returns the location associated with this element.

Specified by:

getLocation in class Element

getSimpleName

public java.lang.String getSimpleName()

Description copied from class: Element

Returns a simple name for the element.

Specified by:

getSimpleName 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

getMethods

public java.lang.Iterable<RestMethod> getMethods()

Returns the methods associated with this collection.

getReachableMethods

public com.google.common.collect.ImmutableList<RestMethod> getReachableMethods()

Returns the methods associated with this collection and reachable with the current scoper.

getResourceType

@Nullable
public TypeRef getResourceType()

Returns the resource type, or null, if none assigned.

setResourceType

public void setResourceType(@Nullable
                            TypeRef resourceType)

Sets the resource type.

getParent

@Nullable
public CollectionAttribute getParent()

Returns the parent collection, or null if none.

getVersionWithDefault

public java.lang.String getVersionWithDefault()

getFullNameNoVersion

public java.lang.String getFullNameNoVersion()

Returns the full name with version prefix stripped if the full name has it. Returns empty if there is no collection specified in the url.

setParent

public void setParent(CollectionAttribute collection)

Set parent collection.

addMethod

@Nullable
public RestMethod addMethod(RestMethod method)

Add method to collection. Returns null or the old declaration.