Package org.jibx.extras

Class TypedArrayMapper

java.lang.Object
org.jibx.extras.TypedArrayMapper
All Implemented Interfaces:
IAliasable, IMarshaller, IUnmarshaller
public class TypedArrayMapper extends Object implements IMarshaller, IUnmarshaller, IAliasable

Custom marshaller/unmarshaller for reference arrays of a particular type. This handles mapping arrays typed as object-type[], where the object-type is any class name (not a primitive type). All items in the array must be of a mapped type. If a name is specified by the mapping definition that name is used as a wrapper around the elements representing the items in the array; otherwise, the elements are just handled inline.

Author:
Dennis M. Sosnoski

  • Field Details

    • DUMMY_ARRAY

      private static final Object[] DUMMY_ARRAY

    • m_uri

      private String m_uri

    • m_index

      private int m_index

    • m_name

      private String m_name

    • m_baseArray

      private Object[] m_baseArray

    • m_holder

      private ArrayList m_holder

  • Constructor Details

    • TypedArrayMapper

      public TypedArrayMapper(String uri, int index, String name, String type)
      Aliased constructor. This takes a name definition for the top-level wrapper element. It'll be used by JiBX when a name is supplied by the mapping which references this custom marshaller/unmarshaller.
      Parameters:
      uri - namespace URI for the top-level element
      index - namespace index corresponding to the defined URI within the marshalling context definitions
      name - local name for the top-level element
      type - class name for type of items in array

    • TypedArrayMapper

      public TypedArrayMapper(String type)
      Class only constructor. This just sets up for an XML representation with no element wrapping the actual item structures. It'll be used by JiBX when no name information is supplied by the mapping which references this custom marshaller/unmarshaller.
      Parameters:
      type - class name for type of items in array

  • Method Details

    • isExtension

      public boolean isExtension(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(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 Object unmarshal(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