org.opensaml.core.xml.io

Class BaseXMLObjectMarshaller

java.lang.Object

org.opensaml.core.xml.io.AbstractXMLObjectMarshaller

org.opensaml.core.xml.io.BaseXMLObjectMarshaller

All Implemented Interfaces:

Marshaller

Direct Known Subclasses:

XSDateTimeMarshaller

public abstract class BaseXMLObjectMarshaller
extends AbstractXMLObjectMarshaller

Base class for Marshaller classes. This base class provides no-op implementations of the methods marshallAttributes(XMLObject, Element) and marshallElementContent(XMLObject, Element). Developers extending this class may need to override one or both of these.

Constructor Summary

Constructors

Constructor and Description
BaseXMLObjectMarshaller()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	marshallAttributes(XMLObject xmlObject, Element domElement) Marshalls a given XMLObject into a W3C Element.
protected void	marshallElementContent(XMLObject xmlObject, Element domElement) Marshalls data from the XMLObject into content of the DOM Element.

Methods inherited from class org.opensaml.core.xml.io.AbstractXMLObjectMarshaller

marshall, marshall, marshall, marshallChildElements, marshallInto, marshallNamespacePrefix, marshallNamespaces, marshallSchemaInstanceAttributes, marshallUnknownAttributes, setDocumentElement

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseXMLObjectMarshaller

public BaseXMLObjectMarshaller()

Method Detail

marshallAttributes

protected void marshallAttributes(@Nonnull
                      XMLObject xmlObject,
                      @Nonnull
                      Element domElement)
                           throws MarshallingException

Marshalls a given XMLObject into a W3C Element. The given signing context should be blindly passed to the marshaller for child elements. The XMLObject passed to this method is guaranteed to be of the target name specified during this unmarshaller's construction. This default implementation of this method is a no-op

Overrides:

marshallAttributes in class AbstractXMLObjectMarshaller

Parameters:

xmlObject - the XMLObject to marshall

domElement - the W3C DOM element

Throws:

MarshallingException - thrown if there is a problem marshalling the element

marshallElementContent

protected void marshallElementContent(@Nonnull
                          XMLObject xmlObject,
                          @Nonnull
                          Element domElement)
                               throws MarshallingException

Marshalls data from the XMLObject into content of the DOM Element. The default implementation of this method is a no-op.

Overrides:

marshallElementContent in class AbstractXMLObjectMarshaller

Parameters:

xmlObject - the XMLObject

domElement - the DOM element recieving the content

Throws:

MarshallingException - thrown if the textual content can not be added to the DOM element