de.twenty11.skysail.server.restlet

Class MethodInfo

java.lang.Object

de.twenty11.skysail.server.restlet.DocumentedInfo

de.twenty11.skysail.server.restlet.MethodInfo

public class MethodInfo
extends DocumentedInfo

Constructor Summary

Constructors

Constructor and Description
MethodInfo() Constructor.
MethodInfo(DocumentationInfo documentation) Constructor with a single documentation element.
MethodInfo(List<DocumentationInfo> documentations) Constructor with a list of documentation elements.
MethodInfo(String documentation) Constructor with a single documentation element.

Method Summary

Methods

Modifier and Type	Method and Description
static void	describeAnnotations(MethodInfo info, org.restlet.resource.ServerResource resource) Automatically describe a method by discovering the resource's annotations.
String	getIdentifier() Returns the identifier for the method.
org.restlet.data.Method	getName() Returns the name of the method.
RequestInfo	getRequest() Returns the input to the method.
ResponseInfo	getResponse() Returns the last added response of the method.
List<ResponseInfo>	getResponses() Returns the output of the method.
org.restlet.data.Reference	getTargetRef() Returns the reference to a method definition element.
void	setIdentifier(String identifier) Sets the identifier for the method.
void	setName(org.restlet.data.Method name) Sets the name of the method.
void	setRequest(RequestInfo request) Sets the input to the method.
void	setResponses(List<ResponseInfo> responses) Sets the output of the method.
void	setTargetRef(org.restlet.data.Reference targetRef) Sets the reference to a method definition element.
String	toString()
void	updateNamespaces(Map<String,String> namespaces) Completes the given map of namespaces with the namespaces used in the documentation elements.

Methods inherited from class de.twenty11.skysail.server.restlet.DocumentedInfo

getDocumentations, resolveNamespaces, setDocumentation, setDocumentation, setDocumentations

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodInfo

public MethodInfo()

Constructor.

MethodInfo

public MethodInfo(DocumentationInfo documentation)

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

MethodInfo

public MethodInfo(List<DocumentationInfo> documentations)

Constructor with a list of documentation elements.

Parameters:

documentations - The list of documentation elements.

MethodInfo

public MethodInfo(String documentation)

Constructor with a single documentation element.

Parameters:

documentation - A single documentation element.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

describeAnnotations

public static void describeAnnotations(MethodInfo info,
                       org.restlet.resource.ServerResource resource)

Automatically describe a method by discovering the resource's annotations.

Parameters:

info - The method description to update.

resource - The server resource to describe.

getIdentifier

public String getIdentifier()

Returns the identifier for the method.

Returns:

The identifier for the method.

getName

public org.restlet.data.Method getName()

Returns the name of the method.

Returns:

The name of the method.

getRequest

public RequestInfo getRequest()

Returns the input to the method.

Returns:

The input to the method.

getResponse

public ResponseInfo getResponse()

Returns the last added response of the method.

Returns:

The last added response of the method.

getResponses

public List<ResponseInfo> getResponses()

Returns the output of the method.

Returns:

The output of the method.

getTargetRef

public org.restlet.data.Reference getTargetRef()

Returns the reference to a method definition element.

Returns:

The reference to a method definition element.

setIdentifier

public void setIdentifier(String identifier)

Sets the identifier for the method.

Parameters:

identifier - The identifier for the method.

setName

public void setName(org.restlet.data.Method name)

Sets the name of the method.

Parameters:

name - The name of the method.

setRequest

public void setRequest(RequestInfo request)

Sets the input to the method.

Parameters:

request - The input to the method.

setResponses

public void setResponses(List<ResponseInfo> responses)

Sets the output of the method.

Parameters:

responses - The output of the method.

setTargetRef

public void setTargetRef(org.restlet.data.Reference targetRef)

Sets the reference to a method definition element.

Parameters:

targetRef - The reference to a method definition element.

updateNamespaces

public void updateNamespaces(Map<String,String> namespaces)

Description copied from class: DocumentedInfo

Completes the given map of namespaces with the namespaces used in the documentation elements. The key is the URI of the namespace and the value, the prefix.

Specified by:

updateNamespaces in class DocumentedInfo

Parameters:

namespaces - The given map of namespaces to complete.