org.jibx.extras
Class Dom4JListMapper
java.lang.Object
org.jibx.extras.DocumentModelMapperBase
org.jibx.extras.Dom4JMapperBase
org.jibx.extras.Dom4JListMapper
- All Implemented Interfaces:
- IMarshaller, IUnmarshaller
public class Dom4JListMapper
- extends Dom4JMapperBase
- implements IMarshaller, IUnmarshaller
Custom content list marshaller/unmarshaller to dom4j representation. This
allows you to mix data binding and document model representations for XML
within the same application. You simply use this marshaller/unmarshaller with
a linked object type that implements java.util.List
(the actual
runtime type - the declared type is ignored and can be anything). When
unmarshalling it will create an instance of java.util.ArrayList
if a list is not passed in and any content is present, then return all the
content up to the close tag for the enclosing element in the list. When
marshalling, it will simply write out any content directly.
- Author:
- Dennis M. Sosnoski
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Dom4JListMapper
public Dom4JListMapper()
isExtension
public boolean isExtension(java.lang.String mapname)
- 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:
mapname
- marshaller mapping name (generally the class name to be
handled, or abstract mapping type name)
- Returns:
true
if this mapping is an extension of the abstract
mapping, false
if not
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 ctx)
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:
ctx
- 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