public class MethodInfo extends DocumentedInfo
| 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.
|
| 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.
|
getDocumentations, resolveNamespaces, setDocumentation, setDocumentation, setDocumentationspublic MethodInfo()
public MethodInfo(DocumentationInfo documentation)
documentation - A single documentation element.public MethodInfo(List<DocumentationInfo> documentations)
documentations - The list of documentation elements.public MethodInfo(String documentation)
documentation - A single documentation element.public static void describeAnnotations(MethodInfo info, org.restlet.resource.ServerResource resource)
info - The method description to update.resource - The server resource to describe.public String getIdentifier()
public org.restlet.data.Method getName()
public RequestInfo getRequest()
public ResponseInfo getResponse()
public List<ResponseInfo> getResponses()
public org.restlet.data.Reference getTargetRef()
public void setIdentifier(String identifier)
identifier - The identifier for the method.public void setName(org.restlet.data.Method name)
name - The name of the method.public void setRequest(RequestInfo request)
request - The input to the method.public void setResponses(List<ResponseInfo> responses)
responses - The output of the method.public void setTargetRef(org.restlet.data.Reference targetRef)
targetRef - The reference to a method definition element.public void updateNamespaces(Map<String,String> namespaces)
DocumentedInfoupdateNamespaces in class DocumentedInfonamespaces - The given map of namespaces to complete.Copyright © 2011-2013. All Rights Reserved.