Summary: Methods | [Expand All]
public interface

Marshaller

org.springframework.oxm.Marshaller
Known Indirect Subclasses

Class Overview

Defines the contract for Object XML Mapping Marshallers. Implementations of this interface can serialize a given Object to an XML Stream.

Although the marshal method accepts a java.lang.Object as its first parameter, most Marshaller implementations cannot handle arbitrary Objects. Instead, a object class must be registered with the marshaller, or have a common base class.

See Also

Summary

Public Methods
abstract void marshal(Object graph, Result result)
Marshals the object graph with the given root into the provided Result.
abstract boolean supports(Class<?> clazz)
Indicates whether this marshaller can marshal instances of the supplied type.

Public Methods

public abstract void marshal (Object graph, Result result)

Marshals the object graph with the given root into the provided Result.

Parameters
graph the root of the object graph to marshal
result the result to marshal to
Throws
IOException if an I/O error occurs
XmlMappingException if the given object cannot be marshalled to the result

public abstract boolean supports (Class<?> clazz)

Indicates whether this marshaller can marshal instances of the supplied type.

Parameters
clazz the class that this marshaller is being asked if it can marshal
Returns
  • true if this marshaller can indeed marshal instances of the supplied class; false otherwise