|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.restlet.ext.wadl.DocumentedInfo
org.restlet.ext.wadl.MethodInfo
public class MethodInfo
Describes the expected requests and responses of a resource method.
Constructor Summary | |
---|---|
MethodInfo()
Constructor. |
|
MethodInfo(DocumentationInfo documentation)
Constructor with a single documentation element. |
|
MethodInfo(java.util.List<DocumentationInfo> documentations)
Constructor with a list of documentation elements. |
|
MethodInfo(java.lang.String documentation)
Constructor with a single documentation element. |
Method Summary | |
---|---|
FaultInfo |
addFault(Status status,
MediaType mediaType,
java.lang.String documentation)
Adds a new fault to the response. |
ParameterInfo |
addRequestParameter(java.lang.String name,
boolean required,
java.lang.String type,
ParameterStyle style,
java.lang.String documentation)
Adds a new request parameter. |
RepresentationInfo |
addRequestRepresentation(Variant variant)
Adds a new request representation based on a given variant. |
ParameterInfo |
addResponseParameter(java.lang.String name,
boolean required,
java.lang.String type,
ParameterStyle style,
java.lang.String documentation)
Adds a new response parameter. |
RepresentationInfo |
addResponseRepresentation(Variant variant)
Adds a new response representation based on a given variant. |
java.lang.String |
getIdentifier()
Returns the identifier for the method. |
Method |
getName()
Returns the name of the method. |
RequestInfo |
getRequest()
Returns the input to the method. |
ResponseInfo |
getResponse()
Returns the output of the method. |
Reference |
getTargetRef()
Returns the reference to a method definition element. |
void |
setIdentifier(java.lang.String identifier)
Sets the identifier for the method. |
void |
setName(Method name)
Sets the name of the method. |
void |
setRequest(RequestInfo request)
Sets the input to the method. |
void |
setResponse(ResponseInfo response)
Sets the output of the method. |
void |
setTargetRef(Reference targetRef)
Sets the reference to a method definition element. |
void |
updateNamespaces(java.util.Map<java.lang.String,java.lang.String> namespaces)
Completes the given map of namespaces with the namespaces used in the documentation elements. |
void |
writeElement(XmlWriter writer)
Writes the current object as an XML element using the given SAX writer. |
Methods inherited from class org.restlet.ext.wadl.DocumentedInfo |
---|
getDocumentations, resolveNamespaces, setDocumentation, setDocumentation, setDocumentations |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
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.Method Detail |
---|
public FaultInfo addFault(Status status, MediaType mediaType, java.lang.String documentation)
status
- The associated status code.mediaType
- The fault representation's media type.documentation
- A single documentation element.
public ParameterInfo addRequestParameter(java.lang.String name, boolean required, java.lang.String type, ParameterStyle style, java.lang.String documentation)
name
- The name of the parameter.required
- True if thes parameter is required.type
- The type of the parameter.style
- The style of the parameter.documentation
- A single documentation element.
public RepresentationInfo addRequestRepresentation(Variant variant)
variant
- The variant to describe.
public ParameterInfo addResponseParameter(java.lang.String name, boolean required, java.lang.String type, ParameterStyle style, java.lang.String documentation)
name
- The name of the parameter.required
- True if thes parameter is required.type
- The type of the parameter.style
- The style of the parameter.documentation
- A single documentation element.
public RepresentationInfo addResponseRepresentation(Variant variant)
variant
- The variant to describe.
public java.lang.String getIdentifier()
public Method getName()
public RequestInfo getRequest()
public ResponseInfo getResponse()
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 setResponse(ResponseInfo response)
response
- 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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |