com.flat502.rox.marshal
Interface MethodCallUnmarshaller

All Superinterfaces:
MethodUnmarshaller
All Known Subinterfaces:
ExtendedMethodCallUnmarshaller
All Known Implementing Classes:
DomMethodCallUnmarshaller, SaxMethodCallUnmarshaller

public interface MethodCallUnmarshaller
extends MethodUnmarshaller

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


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

Method Detail

unmarshal

RpcCall unmarshal(java.io.InputStream in,
                  MethodCallUnmarshallerAid aid)
                  throws java.lang.Exception
Unmarshal an RpcCall 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 RpcCall instance.
aid - A MethodCallUnmarshallerAid providing the mapping between method parameters when unmarshalling structs. May be null, in which case Map instances will be used in all cases. May also override the default FieldNameCodec.
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

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

Parameters:
in - The Reader from which to unmarshal a new RpcCall instance.
aid - A MethodCallUnmarshallerAid providing the mapping between method parameters when unmarshalling structs. May be null, in which case Map instances will be used in all cases. May also override the default FieldNameCodec.
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

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

Parameters:
xml - The XML string from which to unmarshal a new RpcCall instance.
aid - A MethodCallUnmarshallerAid providing the mapping between method parameters when unmarshalling structs. May be null, in which case Map instances will be used in all cases. May also override the default FieldNameCodec.
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.