@Deprecated public class MethodInfo extends DocumentedInfo
Constructor and Description |
---|
MethodInfo()
Deprecated.
Constructor.
|
MethodInfo(DocumentationInfo documentation)
Deprecated.
Constructor with a single documentation element.
|
MethodInfo(java.util.List<DocumentationInfo> documentations)
Deprecated.
Constructor with a list of documentation elements.
|
MethodInfo(java.lang.String documentation)
Deprecated.
Constructor with a single documentation element.
|
Modifier and Type | Method and Description |
---|---|
static void |
describeAnnotations(MethodInfo info,
ServerResource resource)
Deprecated.
Automatically describe a method by discovering the resource's
annotations.
|
java.lang.String |
getIdentifier()
Deprecated.
Returns the identifier for the method.
|
Method |
getName()
Deprecated.
Returns the name of the method.
|
RequestInfo |
getRequest()
Deprecated.
Returns the input to the method.
|
ResponseInfo |
getResponse()
Deprecated.
Returns the last added response of the method.
|
java.util.List<ResponseInfo> |
getResponses()
Deprecated.
Returns the output of the method.
|
Reference |
getTargetRef()
Deprecated.
Returns the reference to a method definition element.
|
void |
setIdentifier(java.lang.String identifier)
Deprecated.
Sets the identifier for the method.
|
void |
setName(Method name)
Deprecated.
Sets the name of the method.
|
void |
setRequest(RequestInfo request)
Deprecated.
Sets the input to the method.
|
void |
setResponses(java.util.List<ResponseInfo> responses)
Deprecated.
Sets the output of the method.
|
void |
setTargetRef(Reference targetRef)
Deprecated.
Sets the reference to a method definition element.
|
void |
updateNamespaces(java.util.Map<java.lang.String,java.lang.String> namespaces)
Deprecated.
Completes the given map of namespaces with the namespaces used in the
documentation elements.
|
void |
writeElement(XmlWriter writer)
Deprecated.
Writes the current object as an XML element using the given SAX writer.
|
getDocumentations, resolveNamespaces, setDocumentation, setDocumentation, setDocumentations
public MethodInfo()
public MethodInfo(DocumentationInfo documentation)
documentation
- A single documentation element.public MethodInfo(java.util.List<DocumentationInfo> documentations)
documentations
- The list of documentation elements.public MethodInfo(java.lang.String documentation)
documentation
- A single documentation element.public static void describeAnnotations(MethodInfo info, ServerResource resource)
info
- The method description to update.resource
- The server resource to describe.public java.lang.String getIdentifier()
public Method getName()
public RequestInfo getRequest()
public ResponseInfo getResponse()
public java.util.List<ResponseInfo> getResponses()
public Reference getTargetRef()
public void setIdentifier(java.lang.String identifier)
identifier
- The identifier for the method.public void setName(Method name)
name
- The name of the method.public void setRequest(RequestInfo request)
request
- The input to the method.public void setResponses(java.util.List<ResponseInfo> responses)
responses
- The output of the method.public void setTargetRef(Reference targetRef)
targetRef
- The reference to a method definition element.public void updateNamespaces(java.util.Map<java.lang.String,java.lang.String> namespaces)
DocumentedInfo
updateNamespaces
in class DocumentedInfo
namespaces
- The given map of namespaces to complete.public void writeElement(XmlWriter writer) throws org.xml.sax.SAXException
writer
- The SAX writer.org.xml.sax.SAXException
Copyright © 2005-2020 Restlet.