com.flat502.rox.marshal
Interface MethodResponseUnmarshaller

All Superinterfaces:
MethodUnmarshaller
All Known Subinterfaces:
ExtendedMethodResponseUnmarshaller
All Known Implementing Classes:
DomMethodResponseUnmarshaller, SaxMethodResponseUnmarshaller

public interface MethodResponseUnmarshaller
extends MethodUnmarshaller

Encapsulates the methods required to unmarshal an RpcResponse from various sources.


Method Summary
 RpcResponse unmarshal(java.io.InputStream in, MethodResponseUnmarshallerAid aid)
          Unmarshal an RpcResponse instance from an InputStream.
 RpcResponse unmarshal(java.io.Reader in, MethodResponseUnmarshallerAid aid)
          Unmarshal an RpcResponse instance from a Reader.
 RpcResponse unmarshal(java.lang.String xml, MethodResponseUnmarshallerAid aid)
          Unmarshal an RpcResponse instance from an XML string.
 
Methods inherited from interface com.flat502.rox.marshal.MethodUnmarshaller
getDefaultFieldNameCodec
 

Method Detail

unmarshal

RpcResponse unmarshal(java.io.InputStream in,
                      MethodResponseUnmarshallerAid aid)
                      throws java.lang.Exception
Unmarshal an RpcResponse instance from an InputStream.

Implementations are responsible for determining the stream's character encoding (where applicable).

Parameters:
in - The InputStream from which to unmarshal a new RpcResponse instance.
aid - The MethodResponseUnmarshallerAid to use when unmarshalling the response. May be null, in which internal defaults will be used
Returns:
A new instance of this class representing the XML structure in the given document.
Throws:
java.lang.Exception - Implementations are free to throw exceptions.

unmarshal

RpcResponse unmarshal(java.io.Reader in,
                      MethodResponseUnmarshallerAid aid)
                      throws java.lang.Exception
Unmarshal an RpcResponse instance from a Reader.

Parameters:
in - The Reader from which to unmarshal a new RpcResponse instance.
aid - The MethodResponseUnmarshallerAid to use when unmarshalling the response. May be null, in which internal defaults will be used
Returns:
A new instance of this class representing the XML structure in the given document.
Throws:
java.lang.Exception - Implementations are free to throw exceptions.

unmarshal

RpcResponse unmarshal(java.lang.String xml,
                      MethodResponseUnmarshallerAid aid)
                      throws java.lang.Exception
Unmarshal an RpcResponse instance from an XML string.

Parameters:
xml - The XML string from which to unmarshal a new RpcResponse instance.
aid - The MethodResponseUnmarshallerAid to use when unmarshalling the response. May be null, in which internal defaults will be used
Returns:
A new instance of this class representing the XML structure in the given document.
Throws:
java.lang.Exception - Implementations are free to throw exceptions.