com.flat502.rox.marshal.xmlrpc
Class SaxMethodResponseUnmarshaller

java.lang.Object
  com.flat502.rox.marshal.xmlrpc.SaxMethodResponseUnmarshaller

All Implemented Interfaces:

ExtendedMethodResponseUnmarshaller, MethodResponseUnmarshaller, MethodUnmarshaller

public class SaxMethodResponseUnmarshaller
extends java.lang.Object
implements ExtendedMethodResponseUnmarshaller

Parse XML RPC method response using SAX.

Constructor Summary

SaxMethodResponseUnmarshaller()

SaxMethodResponseUnmarshaller(SaxParserPool pool)

Method Summary

protected RpcResponse	buildXmlRpcResponse(SaxUnmarshaller unmarshaller)
FieldNameCodec	getDefaultFieldNameCodec() This method is invoked when no specific FieldNameCodec exists.
protected RpcResponse	unmarshal(org.xml.sax.InputSource in, MethodResponseUnmarshallerAid aid)
RpcResponse	unmarshal(java.io.InputStream in) Unmarshal an RpcResponse instance from an InputStream.
RpcResponse	unmarshal(java.io.InputStream in, MethodResponseUnmarshallerAid aid) Unmarshal an RpcResponse instance from an InputStream.
RpcResponse	unmarshal(java.io.Reader in) Unmarshal an RpcResponse instance from a Reader.
RpcResponse	unmarshal(java.io.Reader in, MethodResponseUnmarshallerAid aid) Unmarshal an RpcResponse instance from a Reader.
RpcResponse	unmarshal(java.lang.String xml) Unmarshal an RpcResponse instance from an XML string.
RpcResponse	unmarshal(java.lang.String xml, MethodResponseUnmarshallerAid aid) Unmarshal an RpcResponse instance from an XML string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SaxMethodResponseUnmarshaller

public SaxMethodResponseUnmarshaller(SaxParserPool pool)

SaxMethodResponseUnmarshaller

public SaxMethodResponseUnmarshaller()

Method Detail

buildXmlRpcResponse

protected RpcResponse buildXmlRpcResponse(SaxUnmarshaller unmarshaller)

unmarshal

public RpcResponse unmarshal(java.io.InputStream in,
                             MethodResponseUnmarshallerAid aid)
                      throws java.lang.Exception

Description copied from interface: MethodResponseUnmarshaller

Unmarshal an RpcResponse instance from an InputStream.

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

Specified by:

unmarshal in interface MethodResponseUnmarshaller

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

protected RpcResponse unmarshal(org.xml.sax.InputSource in,
                                MethodResponseUnmarshallerAid aid)
                         throws java.lang.Exception

Throws:

java.lang.Exception

unmarshal

public RpcResponse unmarshal(java.io.Reader in,
                             MethodResponseUnmarshallerAid aid)
                      throws java.lang.Exception

Description copied from interface: MethodResponseUnmarshaller

Unmarshal an RpcResponse instance from a Reader.

Specified by:

unmarshal in interface MethodResponseUnmarshaller

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

public RpcResponse unmarshal(java.lang.String xml,
                             MethodResponseUnmarshallerAid aid)
                      throws java.lang.Exception

Description copied from interface: MethodResponseUnmarshaller

Unmarshal an RpcResponse instance from an XML string.

Specified by:

unmarshal in interface MethodResponseUnmarshaller

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.

unmarshal

public RpcResponse unmarshal(java.io.InputStream in)
                      throws java.lang.Exception

Description copied from interface: ExtendedMethodResponseUnmarshaller

Unmarshal an RpcResponse instance from an InputStream.

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

Specified by:

unmarshal in interface ExtendedMethodResponseUnmarshaller

Parameters:

in - The InputStream from which to unmarshal a new RpcResponse instance.

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

public RpcResponse unmarshal(java.io.Reader in)
                      throws java.lang.Exception

Description copied from interface: ExtendedMethodResponseUnmarshaller

Unmarshal an RpcResponse instance from a Reader.

Specified by:

unmarshal in interface ExtendedMethodResponseUnmarshaller

Parameters:

in - The Reader from which to unmarshal a new RpcResponse instance.

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

public RpcResponse unmarshal(java.lang.String xml)
                      throws java.lang.Exception

Description copied from interface: ExtendedMethodResponseUnmarshaller

Unmarshal an RpcResponse instance from an XML string.

Specified by:

unmarshal in interface ExtendedMethodResponseUnmarshaller

Parameters:

xml - The XML string from which to unmarshal a new RpcResponse instance.

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.

getDefaultFieldNameCodec

public FieldNameCodec getDefaultFieldNameCodec()

Description copied from interface: MethodUnmarshaller

This method is invoked when no specific FieldNameCodec exists.

For client implementations this typically means no codec has been set on the client.

For server implementations this typically means UnmarshallerAid.getFieldNameCodec(String) has returned null.

Specified by:

getDefaultFieldNameCodec in interface MethodUnmarshaller

Returns:

the default codec associated with this unmarshaller.