com.adaptris.core

Class AbstractMarshaller

java.lang.Object

com.adaptris.core.AbstractMarshaller

All Implemented Interfaces:

AdaptrisMarshaller

Direct Known Subclasses:

StatisticMarshaller, XStreamMarshallerImpl

public abstract class AbstractMarshaller
extends java.lang.Object
implements AdaptrisMarshaller

Abstract implementation of AdaptrisMarshaller.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AbstractMarshaller.Deserializer
protected static interface	AbstractMarshaller.Serializer

Nested classes/interfaces inherited from interface com.adaptris.core.AdaptrisMarshaller

AdaptrisMarshaller.MarshalInputStream, AdaptrisMarshaller.MarshalOutputStream

Constructor Summary

Constructors

Constructor and Description
AbstractMarshaller()

Method Summary

Modifier and Type	Method and Description
protected java.io.InputStream	connectToUrl(URLString loc) Deprecated. since 3.6.3; use URLHelper.connect(URLString) instead.
protected static java.lang.Object	invokeDeserialize(AbstractMarshaller.Deserializer u) Wrap the unmarshalling sequence by catching exceptions and re-throwing as CoreExceptions.
protected static void	invokeSerialize(AbstractMarshaller.Serializer m) Wrap the marshalling sequence by catching exceptions and re-throwing as CoreExceptions.
void	marshal(java.lang.Object obj, java.io.File fileName) Marshalls an object to XML.
void	marshal(java.lang.Object obj, java.io.OutputStream outputStream) Marshalls an object to XML.
void	marshal(java.lang.Object obj, java.lang.String fileName) Marshalls an object to XML.
void	marshal(java.lang.Object obj, java.net.URL fileUrl) Marshalls an XML representation of the passed Object to the file sytem location denoted by the passed URL.
java.lang.Object	unmarshal(java.io.File file) Unmarshalls an Object based on the passed file.
java.lang.Object	unmarshal(java.io.InputStream stream) Unmarshals an Object based on the passed InputStream.
java.lang.Object	unmarshal(java.lang.String xml) Unmarshalls an Object from the passed XML.
java.lang.Object	unmarshal(java.net.URL url) Unmarshalls an Object based on the passed file system URL.
java.lang.Object	unmarshal(URLString loc) Unmarshals an Object from the passed URLString location.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.AdaptrisMarshaller

marshal, marshal, uncheckedMarshal, uncheckedUnmarshal, unmarshal

Constructor Detail

AbstractMarshaller

public AbstractMarshaller()

Method Detail

marshal

public void marshal(java.lang.Object obj,
                    java.lang.String fileName)
             throws CoreException

Description copied from interface: AdaptrisMarshaller

Marshalls an object to XML.

Specified by:

marshal in interface AdaptrisMarshaller

Parameters:

obj - the Object to marshall to XML

fileName - the name of the file to write to

Throws:

CoreException - wrapping any underlying Exception

See Also:

AdaptrisMarshaller.marshal(java.lang.Object, java.lang.String)

marshal

public void marshal(java.lang.Object obj,
                    java.io.File fileName)
             throws CoreException

Description copied from interface: AdaptrisMarshaller

Marshalls an object to XML.

Specified by:

marshal in interface AdaptrisMarshaller

Parameters:

obj - the Object to marshall to XML

fileName - the file to write to

Throws:

CoreException - wrapping any underlying Exception

See Also:

AdaptrisMarshaller.marshal(java.lang.Object, File)

marshal

public void marshal(java.lang.Object obj,
                    java.io.OutputStream outputStream)
             throws CoreException

Description copied from interface: AdaptrisMarshaller

Marshalls an object to XML.

Specified by:

marshal in interface AdaptrisMarshaller

Parameters:

obj - the object to marshall to XML

outputStream - the OutputStream to write to

Throws:

CoreException - wrapping any underlying Exception

See Also:

AdaptrisMarshaller.marshal(java.lang.Object, OutputStream)

marshal

public void marshal(java.lang.Object obj,
                    java.net.URL fileUrl)
             throws CoreException

Description copied from interface: AdaptrisMarshaller

Marshalls an XML representation of the passed Object to the file sytem location denoted by the passed URL.

Specified by:

marshal in interface AdaptrisMarshaller

Parameters:

obj - the Object to marshall to XML

fileUrl - the file system location to write to

Throws:

CoreException - wrapping any underlying Exception

See Also:

AdaptrisMarshaller.marshal(java.lang.Object, java.net.URL)

unmarshal

public java.lang.Object unmarshal(java.lang.String xml)
                           throws CoreException

Description copied from interface: AdaptrisMarshaller

Unmarshalls an Object from the passed XML.

Specified by:

unmarshal in interface AdaptrisMarshaller

Parameters:

xml - the String to unmarshal

Returns:

an Object

Throws:

CoreException - wrapping any underlying Exception

See Also:

AdaptrisMarshaller.unmarshal(java.lang.String)

unmarshal

public java.lang.Object unmarshal(java.io.File file)
                           throws CoreException

Description copied from interface: AdaptrisMarshaller

Unmarshalls an Object based on the passed file.

Specified by:

unmarshal in interface AdaptrisMarshaller

Parameters:

file - a file containing XML to unmarshal

Returns:

an Object

Throws:

CoreException - wrapping any underlying Exception

See Also:

AdaptrisMarshaller.unmarshal(java.io.File)

unmarshal

public java.lang.Object unmarshal(java.net.URL url)
                           throws CoreException

Description copied from interface: AdaptrisMarshaller

Unmarshalls an Object based on the passed file system URL.

Specified by:

unmarshal in interface AdaptrisMarshaller

Parameters:

url - the file system location to read from

Returns:

an Object

Throws:

CoreException - wrapping any underlying Exception

See Also:

AdaptrisMarshaller.unmarshal(java.net.URL)

unmarshal

public java.lang.Object unmarshal(URLString loc)
                           throws CoreException

Description copied from interface: AdaptrisMarshaller

Unmarshals an Object from the passed URLString location.

Specified by:

unmarshal in interface AdaptrisMarshaller

Parameters:

loc - the location to unmarshal from

Returns:

the unmarshalled Object

Throws:

CoreException - wrapping any underlying Exceptions

unmarshal

public java.lang.Object unmarshal(java.io.InputStream stream)
                           throws CoreException

Description copied from interface: AdaptrisMarshaller

Unmarshals an Object based on the passed InputStream.

Specified by:

unmarshal in interface AdaptrisMarshaller

Parameters:

stream - an InputStream of XML to unmarshal

Returns:

an Object

Throws:

CoreException - wrapping any underlying Exception

connectToUrl

@Deprecated
 @Removal(version="3.10.0",
         message="deprecated since 3.6.3; use URLHelper instead")
protected java.io.InputStream connectToUrl(URLString loc)
                                                                                                                                              throws java.io.IOException

Deprecated. since 3.6.3; use URLHelper.connect(URLString) instead.

Connect to the specified URL.

Parameters:

loc - the URL location.

Returns:

an InputStream containing the contents of the URL specified.

Throws:

java.io.IOException - on error.

invokeDeserialize

protected static java.lang.Object invokeDeserialize(AbstractMarshaller.Deserializer u)
                                             throws CoreException

Wrap the unmarshalling sequence by catching exceptions and re-throwing as CoreExceptions.

Throws:

CoreException

invokeSerialize

protected static void invokeSerialize(AbstractMarshaller.Serializer m)
                               throws CoreException

Wrap the marshalling sequence by catching exceptions and re-throwing as CoreExceptions.

Throws:

CoreException