org.jibx.extras
Class CommentMapper

java.lang.Object
  extended byorg.jibx.extras.CommentMapper
All Implemented Interfaces:
IMarshaller, IUnmarshaller
Direct Known Subclasses:
FormattedCommentMapper

public class CommentMapper
extends java.lang.Object
implements IMarshaller, IUnmarshaller

Custom marshaller/unmarshaller for comments to strings. When unmarshalling this looks for a comment preceding the first element start or end tag, and if a comment is found converts it to a java.lang.String.

Version:
1.0
Author:
Dennis M. Sosnoski

Constructor Summary
CommentMapper()
           
 
Method Summary
 boolean isExtension(int index)
          Check if marshaller represents an extension mapping.
 boolean isPresent(IUnmarshallingContext ictx)
          Check if instance present in XML.
 void marshal(java.lang.Object obj, IMarshallingContext ictx)
          Marshal instance of handled class.
 java.lang.Object unmarshal(java.lang.Object obj, IUnmarshallingContext ictx)
          Unmarshal instance of handled class.
protected  void writeComment(java.lang.Object obj, IXMLWriter ixw)
          Write comment data to output.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CommentMapper

public CommentMapper()
Method Detail

isExtension

public boolean isExtension(int index)
Description copied from interface: IMarshaller
Check if marshaller represents an extension mapping. This is used by the framework in generated code to verify compatibility of objects being marshalled using an abstract mapping.

Specified by:
isExtension in interface IMarshaller
Parameters:
index - abstract mapping index to be checked
Returns:
true if this mapping is an extension of the abstract mapping, false if not

writeComment

protected void writeComment(java.lang.Object obj,
                            IXMLWriter ixw)
                     throws java.io.IOException
Write comment data to output. This method is designed to allow special formatting by subclasses.

Parameters:
obj - object to be written as text
ixw - XML writer for output document
Throws:
java.io.IOException - on error writing to output

marshal

public void marshal(java.lang.Object obj,
                    IMarshallingContext ictx)
             throws JiBXException
Description copied from interface: IMarshaller
Marshal instance of handled class. This method call is responsible for all handling of the marshalling of an object to XML text. It is called at the point where the start tag for the associated element should be generated.

Specified by:
marshal in interface IMarshaller
Parameters:
obj - object to be marshalled (may be null if property is not optional)
ictx - XML text output context
Throws:
JiBXException - on error in marshalling process

isPresent

public boolean isPresent(IUnmarshallingContext ictx)
                  throws JiBXException
Description copied from interface: IUnmarshaller
Check if instance present in XML. This method can be called when the unmarshalling context is positioned at or just before the start of the data corresponding to an instance of this mapping. It verifies that the expected data is present.

Specified by:
isPresent in interface IUnmarshaller
Parameters:
ictx - unmarshalling context
Returns:
true if expected parse data found, false if not
Throws:
JiBXException - on error in unmarshalling process

unmarshal

public java.lang.Object unmarshal(java.lang.Object obj,
                                  IUnmarshallingContext ictx)
                           throws JiBXException
Description copied from interface: IUnmarshaller
Unmarshal instance of handled class. This method call is responsible for all handling of the unmarshalling of an object from XML text, including creating the instance of the handled class if an instance is not supplied. When it is called the unmarshalling context is always positioned at or just before the start tag corresponding to the start of the class data.

Specified by:
unmarshal in interface IUnmarshaller
Parameters:
obj - object to be unmarshalled (may be null)
ictx - unmarshalling context
Returns:
unmarshalled object (may be null)
Throws:
JiBXException - on error in unmarshalling process


Project Web Site