com.google.api.server.spi

Class MethodHierarchyReader

java.lang.Object

com.google.api.server.spi.MethodHierarchyReader

public class MethodHierarchyReader
extends java.lang.Object

Utility to take a class and create maps of methods usable for endpoints and related data.

On the first call, parses and stores the full hierarchy information. The cached full hierarchy is then used for all subsequent calls. Returned iterables, maps, and lists are copied out without reference to the original full hierarchy information to allow the caller to keep just the needed portion of information and release the full hierarchy along with this class.

Constructor Summary

Constructors

Constructor and Description
MethodHierarchyReader(java.lang.Class<?> endpointClass) Constructs a MethodHierarchyReader for the given class type.

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<java.util.List<EndpointMethod>>	getEndpointOverrides() Returns a collection of public service methods defined by the class and its super classes.
java.lang.Iterable<EndpointMethod>	getLeafEndpointMethods() Returns a collection of public service methods defined by the class and its super classes.
java.lang.Iterable<java.lang.reflect.Method>	getLeafMethods() Returns a collection of public service methods defined by the class and its super classes.
java.lang.Iterable<java.util.List<java.lang.reflect.Method>>	getMethodOverrides() Returns a collection of public service methods defined by the class and its super classes.
com.google.common.collect.ListMultimap<java.lang.String,EndpointMethod>	getNameToEndpointOverridesMap() Returns a mapping of public service methods defined by the class and its super classes, keyed by method name.
java.util.Map<java.lang.String,java.lang.reflect.Method>	getNameToLeafMethodMap() Returns a mapping of public service methods defined by the class and its super classes, keyed by method name.

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodHierarchyReader

public MethodHierarchyReader(java.lang.Class<?> endpointClass)

Constructs a MethodHierarchyReader for the given class type.

Parameters:

endpointClass - Must be a concrete type (not abstract or interface).

Method Detail

getLeafMethods

public java.lang.Iterable<java.lang.reflect.Method> getLeafMethods()

Returns a collection of public service methods defined by the class and its super classes. Bridge methods are ignored. Only the final leaf subclass version of each method is included.

getLeafEndpointMethods

public java.lang.Iterable<EndpointMethod> getLeafEndpointMethods()

Returns a collection of public service methods defined by the class and its super classes. Bridge methods are ignored. Only the final leaf subclass version of each method is included. Methods are stored in the EndpointMethod container.

getMethodOverrides

public java.lang.Iterable<java.util.List<java.lang.reflect.Method>> getMethodOverrides()

Returns a collection of public service methods defined by the class and its super classes. Bridge methods are ignored. For each method, all valid method implementations are included, ordered subclass to superclass.

getEndpointOverrides

public java.lang.Iterable<java.util.List<EndpointMethod>> getEndpointOverrides()

Returns a collection of public service methods defined by the class and its super classes. Bridge methods are ignored. For each method, all valid method implementations are included, ordered subclass to superclass. Methods are stored in the EndpointMethod container.

getNameToLeafMethodMap

public java.util.Map<java.lang.String,java.lang.reflect.Method> getNameToLeafMethodMap()

Returns a mapping of public service methods defined by the class and its super classes, keyed by method name. Bridge methods are ignored. Only the final leaf subclass version of each method is included.

getNameToEndpointOverridesMap

public com.google.common.collect.ListMultimap<java.lang.String,EndpointMethod> getNameToEndpointOverridesMap()

Returns a mapping of public service methods defined by the class and its super classes, keyed by method name. Bridge methods are ignored. All valid method implementations are included, ordered subclass to superclass.