Class TypedArrayMapper

  • All Implemented Interfaces:
    IAliasable, IMarshaller, IUnmarshaller

    public class TypedArrayMapper
    extends java.lang.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 Summary

      Fields 
      Modifier and Type Field Description
      private static java.lang.Object[] DUMMY_ARRAY  
      private java.lang.Object[] m_baseArray  
      private java.util.ArrayList m_holder  
      private int m_index  
      private java.lang.String m_name  
      private java.lang.String m_uri  
    • Constructor Summary

      Constructors 
      Constructor Description
      TypedArrayMapper​(java.lang.String type)
      Class only constructor.
      TypedArrayMapper​(java.lang.String uri, int index, java.lang.String name, java.lang.String type)
      Aliased constructor.
    • Field Detail

      • DUMMY_ARRAY

        private static final java.lang.Object[] DUMMY_ARRAY
      • m_uri

        private java.lang.String m_uri
      • m_index

        private int m_index
      • m_name

        private java.lang.String m_name
      • m_baseArray

        private java.lang.Object[] m_baseArray
      • m_holder

        private java.util.ArrayList m_holder
    • Constructor Detail

      • TypedArrayMapper

        public TypedArrayMapper​(java.lang.String uri,
                                int index,
                                java.lang.String name,
                                java.lang.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​(java.lang.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 Detail

      • 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