org.codehaus.enunciate.contract.jaxrs
Class SubResourceLocator

java.lang.Object
  extended by net.sf.jelly.apt.decorations.declaration.DecoratedDeclaration
      extended by net.sf.jelly.apt.decorations.declaration.DecoratedMemberDeclaration
          extended by net.sf.jelly.apt.decorations.declaration.DecoratedExecutableDeclaration
              extended by net.sf.jelly.apt.decorations.declaration.DecoratedMethodDeclaration
                  extended by org.codehaus.enunciate.contract.jaxrs.SubResourceLocator
All Implemented Interfaces:
com.sun.mirror.declaration.Declaration, com.sun.mirror.declaration.ExecutableDeclaration, com.sun.mirror.declaration.MemberDeclaration, com.sun.mirror.declaration.MethodDeclaration

public class SubResourceLocator
extends net.sf.jelly.apt.decorations.declaration.DecoratedMethodDeclaration

A sub-resource locator. Invoked on a JAX-RS resource in order to locate a subresource.

Author:
Ryan Heaton

Field Summary
 
Fields inherited from class net.sf.jelly.apt.decorations.declaration.DecoratedMethodDeclaration
INHERITDOC_PATTERN
 
Fields inherited from class net.sf.jelly.apt.decorations.declaration.DecoratedExecutableDeclaration
paramsComments, throwsComments
 
Fields inherited from class net.sf.jelly.apt.decorations.declaration.DecoratedDeclaration
delegate, javaDoc
 
Constructor Summary
SubResourceLocator(com.sun.mirror.declaration.MethodDeclaration delegate, Resource parent)
           
 
Method Summary
 com.sun.mirror.declaration.ParameterDeclaration getEntityParameter()
          The entity parameter.
 Resource getParent()
          The resource that hosts this locator.
 java.lang.String getPath()
          The path of the subresource.
 SubResource getResource()
          The resource that this locates.
 java.util.List<ResourceParameter> getResourceParameters()
          The list of resource parameters that this method requires to be invoked.
 
Methods inherited from class net.sf.jelly.apt.decorations.declaration.DecoratedMethodDeclaration
accept, commentNeedsReplacement, constructJavaDoc, getPropertyName, getReturnType, isGetter, isSetter
 
Methods inherited from class net.sf.jelly.apt.decorations.declaration.DecoratedExecutableDeclaration
getFormalTypeParameters, getParameters, getThrownTypes, isVarArgs, parseParamComments
 
Methods inherited from class net.sf.jelly.apt.decorations.declaration.DecoratedMemberDeclaration
getDeclaringType
 
Methods inherited from class net.sf.jelly.apt.decorations.declaration.DecoratedDeclaration
equals, getAnnotation, getAnnotationMirrors, getAnnotations, getDelegate, getDocComment, getDocValue, getJavaDoc, getModifiers, getPosition, getSimpleName, isAbstract, isFinal, isNative, isPrivate, isProtected, isPublic, isStatic, isStrictfp, isSynchronized, isTransient, isVolatile, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.sun.mirror.declaration.ExecutableDeclaration
getFormalTypeParameters, getParameters, getThrownTypes, isVarArgs
 
Methods inherited from interface com.sun.mirror.declaration.MemberDeclaration
getDeclaringType
 
Methods inherited from interface com.sun.mirror.declaration.Declaration
equals, getAnnotation, getAnnotationMirrors, getDocComment, getModifiers, getPosition, getSimpleName
 

Constructor Detail

SubResourceLocator

public SubResourceLocator(com.sun.mirror.declaration.MethodDeclaration delegate,
                          Resource parent)
Method Detail

getPath

public java.lang.String getPath()
The path of the subresource.

Returns:
The path of the subresource.

getResource

public SubResource getResource()
The resource that this locates.

Returns:
The resource that this locates.

getParent

public Resource getParent()
The resource that hosts this locator.

Returns:
The resource that hosts this locator.

getResourceParameters

public java.util.List<ResourceParameter> getResourceParameters()
The list of resource parameters that this method requires to be invoked.

Returns:
The list of resource parameters that this method requires to be invoked.

getEntityParameter

public com.sun.mirror.declaration.ParameterDeclaration getEntityParameter()
The entity parameter.

Returns:
The entity parameter, or null if none.