org.codehaus.enunciate.contract.jaxrs
Annotation Type ResourceMethodSignature


@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface ResourceMethodSignature

Annotation used to "override" the method signature of a REST method that doesn't conform to JAX-RS specification. Used for purposes of leveraging the documentation features of Enunciate without requiring your methods to conform to JAX-RS.

Author:
Ryan Heaton

Optional Element Summary
 javax.ws.rs.CookieParam[] cookieParams
          The set of cookie parameters applicable to this resource method.
 javax.ws.rs.FormParam[] formParams
          The set of form parameters applicable to this resource method.
 javax.ws.rs.HeaderParam[] headerParams
          The set of header parameters applicable to this resource method.
 java.lang.Class<?> input
          The input type for this resource method (i.e.
 javax.ws.rs.MatrixParam[] matrixParams
          The set of matrix parameters applicable to this resource method.
 java.lang.Class<?> output
          The output type for this resource method (what would normally be the JAX-RS return type).
 javax.ws.rs.PathParam[] pathParams
          The set of path parameters applicable to this resource method.
 javax.ws.rs.QueryParam[] queryParams
          The set of query parameters applicable to this resource method.
 

input

public abstract java.lang.Class<?> input
The input type for this resource method (i.e. the "entity parameter").

Returns:
The class the defines the "entity parameter"
Default:
org.codehaus.enunciate.contract.jaxrs.ResourceMethodSignature.NONE.class

output

public abstract java.lang.Class<?> output
The output type for this resource method (what would normally be the JAX-RS return type).

Returns:
The output type for this resource method.
Default:
org.codehaus.enunciate.contract.jaxrs.ResourceMethodSignature.NONE.class

matrixParams

public abstract javax.ws.rs.MatrixParam[] matrixParams
The set of matrix parameters applicable to this resource method.

Returns:
The set of matrix parameters applicable to this resource method.
Default:
{}

queryParams

public abstract javax.ws.rs.QueryParam[] queryParams
The set of query parameters applicable to this resource method.

Returns:
The set of query parameters applicable to this resource method.
Default:
{}

pathParams

public abstract javax.ws.rs.PathParam[] pathParams
The set of path parameters applicable to this resource method.

Returns:
The set of path parameters applicable to this resource method.
Default:
{}

cookieParams

public abstract javax.ws.rs.CookieParam[] cookieParams
The set of cookie parameters applicable to this resource method.

Returns:
The set of cookie parameters applicable to this resource method.
Default:
{}

headerParams

public abstract javax.ws.rs.HeaderParam[] headerParams
The set of header parameters applicable to this resource method.

Returns:
The set of header parameters applicable to this resource method.
Default:
{}

formParams

public abstract javax.ws.rs.FormParam[] formParams
The set of form parameters applicable to this resource method.

Returns:
The set of form parameters applicable to this resource method.
Default:
{}