org.restlet.ext.wadl
Class MethodInfo

java.lang.Object
  extended by org.restlet.ext.wadl.DocumentedInfo
      extended by org.restlet.ext.wadl.MethodInfo

public class MethodInfo
extends DocumentedInfo

Describes the expected requests and responses of a resource method.

Author:
Jerome Louvel

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

MethodInfo

public MethodInfo()
Constructor.


MethodInfo

public MethodInfo(DocumentationInfo documentation)
Constructor with a single documentation element.

Parameters:
documentation - A single documentation element.

MethodInfo

public MethodInfo(java.util.List<DocumentationInfo> documentations)
Constructor with a list of documentation elements.

Parameters:
documentations - The list of documentation elements.

MethodInfo

public MethodInfo(java.lang.String documentation)
Constructor with a single documentation element.

Parameters:
documentation - A single documentation element.
Method Detail

addFault

public FaultInfo addFault(Status status,
                          MediaType mediaType,
                          java.lang.String documentation)
Adds a new fault to the response.

Parameters:
status - The associated status code.
mediaType - The fault representation's media type.
documentation - A single documentation element.
Returns:
The created fault description.

addRequestParameter

public ParameterInfo addRequestParameter(java.lang.String name,
                                         boolean required,
                                         java.lang.String type,
                                         ParameterStyle style,
                                         java.lang.String documentation)
Adds a new request parameter.

Parameters:
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.
Returns:
The created parameter description.

addRequestRepresentation

public RepresentationInfo addRequestRepresentation(Variant variant)
Adds a new request representation based on a given variant.

Parameters:
variant - The variant to describe.
Returns:
The created representation description.

addResponseParameter

public ParameterInfo addResponseParameter(java.lang.String name,
                                          boolean required,
                                          java.lang.String type,
                                          ParameterStyle style,
                                          java.lang.String documentation)
Adds a new response parameter.

Parameters:
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.
Returns:
The created parameter description.

addResponseRepresentation

public RepresentationInfo addResponseRepresentation(Variant variant)
Adds a new response representation based on a given variant.

Parameters:
variant - The variant to describe.
Returns:
The created representation description.

getIdentifier

public java.lang.String getIdentifier()
Returns the identifier for the method.

Returns:
The identifier for the method.

getName

public 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 output of the method.

Returns:
The output of the method.

getTargetRef

public Reference getTargetRef()
Returns the reference to a method definition element.

Returns:
The reference to a method definition element.

setIdentifier

public void setIdentifier(java.lang.String identifier)
Sets the identifier for the method.

Parameters:
identifier - The identifier for the method.

setName

public void setName(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.

setResponse

public void setResponse(ResponseInfo response)
Sets the output of the method.

Parameters:
response - The output of the method.

setTargetRef

public void setTargetRef(Reference targetRef)
Sets the reference to a method definition element.

Parameters:
targetRef - The reference to a method definition element.

updateNamespaces

public void updateNamespaces(java.util.Map<java.lang.String,java.lang.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.

writeElement

public void writeElement(XmlWriter writer)
                  throws org.xml.sax.SAXException
Writes the current object as an XML element using the given SAX writer.

Parameters:
writer - The SAX writer.
Throws:
org.xml.sax.SAXException


Copyright © 2005-2008 Noelios Technologies.