Package org.jibx.binding.def

Class ObjectBinding

java.lang.Object
org.jibx.binding.def.PassThroughComponent
org.jibx.binding.def.ObjectBinding
All Implemented Interfaces:
IComponent, IContextObj, ILinkable, ITypeBinding
public class ObjectBinding extends PassThroughComponent implements IComponent, IContextObj
Binding modifiers that apply to a class reference. This adds the methods used for handling binding operations to the object class (or a helper class), then generates calls to the added methods as this binding definition is used.
Author:
Dennis M. Sosnoski

  • Field Details

    • MARSHAL_HOOK_SIGNATURES

      private static final String[] MARSHAL_HOOK_SIGNATURES

    • FACTORY_HOOK_SIGNATURES

      private static final String[] FACTORY_HOOK_SIGNATURES

    • UNMARSHAL_HOOK_SIGNATURES

      private static final String[] UNMARSHAL_HOOK_SIGNATURES

    • UNMARSHAL_GETSTACKTOPMETHOD

      private static final String UNMARSHAL_GETSTACKTOPMETHOD
      See Also:

    • MARSHAL_GETSTACKTOPMETHOD

      private static final String MARSHAL_GETSTACKTOPMETHOD
      See Also:

    • GETSTACKTOP_SIGNATURE

      private static final String GETSTACKTOP_SIGNATURE
      See Also:

    • MARSHALLING_CONTEXT

      private static final String MARSHALLING_CONTEXT
      See Also:

    • UNMARSHALLING_CONTEXT

      private static final String UNMARSHALLING_CONTEXT
      See Also:

    • UNMARSHAL_PARAMETER_SIGNATURE

      private static final String UNMARSHAL_PARAMETER_SIGNATURE
      See Also:

    • UNMARSHAL_PUSHOBJECTMETHOD

      private static final String UNMARSHAL_PUSHOBJECTMETHOD
      See Also:

    • UNMARSHAL_PUSHTRACKEDOBJECTMETHOD

      private static final String UNMARSHAL_PUSHTRACKEDOBJECTMETHOD
      See Also:

    • MARSHAL_PUSHOBJECTMETHOD

      private static final String MARSHAL_PUSHOBJECTMETHOD
      See Also:

    • PUSHOBJECT_SIGNATURE

      private static final String PUSHOBJECT_SIGNATURE
      See Also:

    • UNMARSHAL_POPOBJECTMETHOD

      private static final String UNMARSHAL_POPOBJECTMETHOD
      See Also:

    • MARSHAL_POPOBJECTMETHOD

      private static final String MARSHAL_POPOBJECTMETHOD
      See Also:

    • POPOBJECT_SIGNATURE

      private static final String POPOBJECT_SIGNATURE
      See Also:

    • UNMARSHAL_PARAMETER_NORET_SIGNATURE

      private static final String UNMARSHAL_PARAMETER_NORET_SIGNATURE
      See Also:

    • MARSHAL_PARAMETER_NORET_SIGNATURE

      private static final String MARSHAL_PARAMETER_NORET_SIGNATURE
      See Also:

    • NEWINSTANCE_SUFFIX

      private static final String NEWINSTANCE_SUFFIX
      See Also:

    • PREPARE_SUFFIX

      private static final String PREPARE_SUFFIX
      See Also:

    • COMPLETE_SUFFIX

      private static final String COMPLETE_SUFFIX
      See Also:

    • ATTR_PRESENCE_SUFFIX

      private static final String ATTR_PRESENCE_SUFFIX
      See Also:

    • UNMARSHAL_ATTR_SUFFIX

      private static final String UNMARSHAL_ATTR_SUFFIX
      See Also:

    • MARSHAL_ATTR_SUFFIX

      private static final String MARSHAL_ATTR_SUFFIX
      See Also:

    • PRESENCE_SUFFIX

      private static final String PRESENCE_SUFFIX
      See Also:

    • UNMARSHAL_SUFFIX

      private static final String UNMARSHAL_SUFFIX
      See Also:

    • MARSHAL_SUFFIX

      private static final String MARSHAL_SUFFIX
      See Also:

    • UNMARSHALCONTEXT_TYPE

      private static final Type UNMARSHALCONTEXT_TYPE

    • UNMARSHALCONTEXT_ARGS

      private static final Type[] UNMARSHALCONTEXT_ARGS

    • MARSHALCONTEXT_TYPE

      private static final Type MARSHALCONTEXT_TYPE

    • SOURCE_TRACKING_INTERFACE

      private static final String SOURCE_TRACKING_INTERFACE
      See Also:

    • SETSOURCE_METHODNAME

      private static final String SETSOURCE_METHODNAME
      See Also:

    • SETSOURCE_ARGS

      private static final Type[] SETSOURCE_ARGS

    • SOURCEDOCUMENT_FIELDNAME

      private static final String SOURCEDOCUMENT_FIELDNAME
      See Also:

    • SOURCELINE_FIELDNAME

      private static final String SOURCELINE_FIELDNAME
      See Also:

    • SOURCECOLUMN_FIELDNAME

      private static final String SOURCECOLUMN_FIELDNAME
      See Also:

    • SOURCENAME_METHODNAME

      private static final String SOURCENAME_METHODNAME
      See Also:

    • SOURCELINE_METHODNAME

      private static final String SOURCELINE_METHODNAME
      See Also:

    • SOURCECOLUMN_METHODNAME

      private static final String SOURCECOLUMN_METHODNAME
      See Also:

    • EMPTY_ARGS

      private static final Type[] EMPTY_ARGS

    • m_container

      private final IContainer m_container
      Containing binding definition structure.

    • m_class

      private BoundClass m_class
      Class linked to mapping.

    • m_factoryMethod

      private final ClassItem m_factoryMethod
      Object factory method.

    • m_preSetMethod

      private final ClassItem m_preSetMethod
      Preset method for object.

    • m_postSetMethod

      private final ClassItem m_postSetMethod
      Postset method for object.

    • m_preGetMethod

      private final ClassItem m_preGetMethod
      Preget method for object.

    • m_createClass

      private final ClassFile m_createClass
      Type to be used for creating new instances.

    • m_createName

      private String m_createName
      Create method fully-qualified name (null if not yet generated).

    • m_checkedComplete

      private boolean m_checkedComplete
      Checked for complete method needed flag.

    • m_checkedPrepare

      private boolean m_checkedPrepare
      Checked for prepare method needed flag.

    • m_completeName

      private String m_completeName
      Complete method name (null if none, or not yet checked).

    • m_prepareName

      private String m_prepareName
      Prepare method name (null if none, or not yet checked).

    • m_newInstanceMethod

      private ClassItem m_newInstanceMethod
      Generated new instance method.

    • m_lockAttributePresence

      private boolean m_lockAttributePresence
      Flag for recursion while generating attribute presence test.

    • m_lockContentPresence

      private boolean m_lockContentPresence
      Flag for recursion while generating content presence test.

    • m_lockAttributeUnmarshal

      private boolean m_lockAttributeUnmarshal
      Flag for recursion while generating attribute unmarshal.

    • m_lockAttributeMarshal

      private boolean m_lockAttributeMarshal
      Flag for recursion while generating attribute marshal.

    • m_lockContentUnmarshal

      private boolean m_lockContentUnmarshal
      Flag for recursion while generating attribute unmarshal.

    • m_lockContentMarshal

      private boolean m_lockContentMarshal
      Flag for recursion while generating attribute marshal.

    • m_attributePresenceName

      private String m_attributePresenceName
      Name for attribute presence test method (null unless generation started).

    • m_contentPresenceName

      private String m_contentPresenceName
      Name for content presence test method (null unless generation started).

    • m_unmarshalSignature

      private String m_unmarshalSignature
      Signature used for unmarshal methods.

    • m_unmarshalAttributeName

      private String m_unmarshalAttributeName
      Name for unmarshal attribute method (null unless generation started).

    • m_unmarshalContentName

      private String m_unmarshalContentName
      Name for unmarshal content method (null unless generation started).

    • m_marshalSignature

      private String m_marshalSignature
      Signature used for marshal methods.

    • m_marshalAttributeName

      private String m_marshalAttributeName
      Name for marshal attribute method (null unless generation started).

    • m_marshalContentName

      private String m_marshalContentName
      Name for marshal content method (null unless generation started).

    • m_attributePresenceMethod

      private ClassItem m_attributePresenceMethod
      Generated attribute presence test method.

    • m_contentPresenceMethod

      private ClassItem m_contentPresenceMethod
      Generated content presence test method.

    • m_unmarshalAttributeMethod

      private ClassItem m_unmarshalAttributeMethod
      Generated unmarshal attribute method.

    • m_unmarshalContentMethod

      private ClassItem m_unmarshalContentMethod
      Generated unmarshal content method.

    • m_marshalAttributeMethod

      private ClassItem m_marshalAttributeMethod
      Generated marshal attribute method.

    • m_marshalContentMethod

      private ClassItem m_marshalContentMethod
      Generated marshal content method.

    • m_idChild

      private IComponent m_idChild
      Child supplying instance identifier value.

    • m_fakeContent

      private boolean m_fakeContent
      Fake content present flag, used when neither content nor attributes are present.

    • m_mappingWrapper

      private boolean m_mappingWrapper
      Flag for dummy object binding, used when a concrete mapping just adds a name around an abstract mapping.

  • Constructor Details

    • ObjectBinding

      public ObjectBinding(IContainer contain, IContextObj objc, String type, String fact, String pres, String posts, String pget, String ctype) throws JiBXException
      Constructor. This initializes the definition context to be the same as the parent's. Subclasses may change this definition context if appropriate.
      Parameters:
      contain - containing binding definition component
      objc - current object context
      type - fully qualified class name for bound object
      fact - user new instance factory method
      pres - user preset method for unmarshalling
      posts - user postset method for unmarshalling
      pget - user preget method for marshalling
      ctype - type to use for creating new instance (null if not specified)
      Throws:
      JiBXException - if method not found

  • Method Details

    • genUserMethodCall

      private void genUserMethodCall(boolean in, ClassItem method, ContextMethodBuilder mb)
      Generate code for calling a user supplied method. The object methods support three signature variations, with no parameters, with the marshalling or unmarshalling context, or with the owning object.
      Parameters:
      in - flag for unmarshalling method
      method - information for method being called
      mb - method builder for generated code

    • genCreateMethod

      private void genCreateMethod() throws JiBXException
      Generate create method for object. The generated method matches the ITypeBinding.getCreateMethod() result signature.
      Throws:
      JiBXException - if error in generating code

    • genPrepareMethod

      private void genPrepareMethod() throws JiBXException
      Generate prepare for marshalling method for object, if needed. The generated method matches the ITypeBinding.getPrepareMethod() result signature.
      Throws:
      JiBXException - if error in generating code

    • genCompleteMethod

      private void genCompleteMethod() throws JiBXException
      Generate unmarshalling complete method for object, if needed. The generated method matches the ITypeBinding.getCompleteMethod() result signature.
      Throws:
      JiBXException - if error in generating code

    • genTrackSourceCode

      private void genTrackSourceCode()
      Generate code to handle unmarshal source location tracking. This convenience method generates the member variables and method used to support setting the source location, the methods used to access the information, and also adds the appropriate interfaces to the class.

    • genAttributePresenceMethod

      private void genAttributePresenceMethod() throws JiBXException
      Generate attribute presence test method for object. The generated method matches the ITypeBinding.getAttributePresentTestMethod() result signature.
      Throws:
      JiBXException - if error in configuration

    • genUnmarshalAttributeMethod

      private void genUnmarshalAttributeMethod() throws JiBXException
      Generate attribute unmarshal method for object. The generated method matches the ITypeBinding.getAttributeUnmarshalMethod() result signature.
      Throws:
      JiBXException - if error in configuration

    • genMarshalAttributeMethod

      private void genMarshalAttributeMethod() throws JiBXException
      Generate attribute marshal method for object. The generated method matches the ITypeBinding.getAttributeMarshalMethod() result signature.
      Throws:
      JiBXException - if error in configuration

    • genContentPresenceMethod

      private void genContentPresenceMethod() throws JiBXException
      Generate content presence test method for object. The generated method matches the ITypeBinding.getContentPresentTestMethod() result signature.
      Throws:
      JiBXException - if error in configuration

    • genUnmarshalContentMethod

      private void genUnmarshalContentMethod() throws JiBXException
      Generate content unmarshal method for object. The generated method matches the ITypeBinding.getContentUnmarshalMethod() result signature.
      Throws:
      JiBXException

    • genMarshalContentMethod

      private void genMarshalContentMethod() throws JiBXException
      Generate content marshal method for object. The generated method matches the ITypeBinding.getContentMarshalMethod() result signature.
      Throws:
      JiBXException

    • getBoundClass

      public BoundClass getBoundClass()
      Description copied from interface: IContextObj
      Get class linked to binding element.
      Specified by:
      getBoundClass in interface IContextObj
      Returns:
      information for class linked by binding

    • setIdChild

      public boolean setIdChild(IComponent child)
      Description copied from interface: IContextObj
      Set ID property. Tells the parent binding element that a particular child defines an ID property for the class linked to the parent.
      Specified by:
      setIdChild in interface IContextObj
      Parameters:
      child - child defining the ID property
      Returns:
      true if successful, false if ID already defined

    • isOptional

      public boolean isOptional()
      Description copied from interface: IComponent
      Check if component is an optional item.
      Specified by:
      isOptional in interface IComponent
      Overrides:
      isOptional in class PassThroughComponent
      Returns:
      true if optional, false if required

    • hasContent

      public boolean hasContent()
      Description copied from interface: IComponent
      Check if component defines one or more elements or text values as children of the containing element. This method is only valid after the call to ILinkable.setLinkages().
      Specified by:
      hasContent in interface IComponent
      Overrides:
      hasContent in class PassThroughComponent
      Returns:
      true if one or more content values defined for containing element, false if not

    • genAttrPresentTest

      public void genAttrPresentTest(ContextMethodBuilder mb) throws JiBXException
      Description copied from interface: IComponent
      Generate code to test for attribute present. This generates code that tests if a child is present as determined by attributes of the containing start tag. It leaves the result of the test (zero if missing, nonzero if present) on the stack. This call is only valid if this component has one or more attributes for the containing element.
      Specified by:
      genAttrPresentTest in interface IComponent
      Overrides:
      genAttrPresentTest in class PassThroughComponent
      Parameters:
      mb - method builder
      Throws:
      JiBXException - if configuration error

    • genContentPresentTest

      public void genContentPresentTest(ContextMethodBuilder mb) throws JiBXException
      Description copied from interface: IComponent
      Generate code to test for content present. This generates code that tests if a required element is present, leaving the result of the test (zero if missing, nonzero if present) on the stack. This call is only valid if this component has one or more content components for the containing element.
      Specified by:
      genContentPresentTest in interface IComponent
      Overrides:
      genContentPresentTest in class PassThroughComponent
      Parameters:
      mb - method builder
      Throws:
      JiBXException - if configuration error

    • genAttributeUnmarshal

      public void genAttributeUnmarshal(ContextMethodBuilder mb) throws JiBXException
      Description copied from interface: IComponent
      Generate attribute unmarshalling code. This is called within the code generation for the unmarshaller of the class associated with the containing element. It needs to generate the necessary code for handling the unmarshalling operation, leaving the unmarshalled object reference on the stack.
      Specified by:
      genAttributeUnmarshal in interface IComponent
      Overrides:
      genAttributeUnmarshal in class PassThroughComponent
      Parameters:
      mb - method builder
      Throws:
      JiBXException - if error in configuration

    • genAttributeMarshal

      public void genAttributeMarshal(ContextMethodBuilder mb) throws JiBXException
      Description copied from interface: IComponent
      Generate attribute marshalling code. This is called within the code generation for the marshaller of the class associated with the containing element. It needs to generate the necessary code for handling the marshalling operation, consuming the marshalled object reference from the stack.
      Specified by:
      genAttributeMarshal in interface IComponent
      Overrides:
      genAttributeMarshal in class PassThroughComponent
      Parameters:
      mb - method builder
      Throws:
      JiBXException - if error in configuration

    • genContentUnmarshal

      public void genContentUnmarshal(ContextMethodBuilder mb) throws JiBXException
      Description copied from interface: IComponent
      Generate element or text unmarshalling code. This is called within the code generation for the unmarshaller of the class associated with the containing element. It needs to generate the necessary code for handling the unmarshalling operation, leaving the unmarshalled object reference on the stack.
      Specified by:
      genContentUnmarshal in interface IComponent
      Overrides:
      genContentUnmarshal in class PassThroughComponent
      Parameters:
      mb - method builder
      Throws:
      JiBXException - if error in configuration

    • genContentMarshal

      public void genContentMarshal(ContextMethodBuilder mb) throws JiBXException
      Description copied from interface: IComponent
      Generate element or text marshalling code. This is called within the code generation for the marshaller of the class associated with the containing element. It needs to generate the necessary code for handling the marshalling operation, consuming the marshalled object reference from the stack.
      Specified by:
      genContentMarshal in interface IComponent
      Overrides:
      genContentMarshal in class PassThroughComponent
      Parameters:
      mb - method builder
      Throws:
      JiBXException - if error in configuration

    • genNewInstance

      public void genNewInstance(ContextMethodBuilder mb) throws JiBXException
      Description copied from interface: IComponent
      Generate code to create new instance of object. This is called within the code generation for the unmarshaller of the class associated with the containing element. It needs to generate the necessary code for creating an instance of the object to be unmarshalled, leaving the object reference on the stack.
      Specified by:
      genNewInstance in interface IComponent
      Overrides:
      genNewInstance in class PassThroughComponent
      Parameters:
      mb - method builder
      Throws:
      JiBXException - if error in configuration

    • getType

      public String getType()
      Description copied from interface: IComponent
      Get type expected by component.
      Specified by:
      getType in interface IComponent
      Overrides:
      getType in class PassThroughComponent
      Returns:
      fully qualified class name of expected type

    • hasId

      public boolean hasId()
      Description copied from interface: IComponent
      Check if component defines an ID value for instances of context object.
      Specified by:
      hasId in interface IComponent
      Overrides:
      hasId in class PassThroughComponent
      Returns:
      true if ID value defined for instances, false if not

    • genLoadId

      public void genLoadId(ContextMethodBuilder mb) throws JiBXException
      Description copied from interface: IComponent
      Generate code to load ID value of instance to stack. The generated code should assume that the top of the stack is the reference for the containing object. It must consume this and leave the actual ID value on the stack (as a String).
      Specified by:
      genLoadId in interface IComponent
      Overrides:
      genLoadId in class PassThroughComponent
      Parameters:
      mb - method builder
      Throws:
      JiBXException - if configuration error

    • setLinkages

      public void setLinkages() throws JiBXException
      Description copied from interface: ILinkable
      Establish and validate linkages between binding components. This is called after the basic binding structures have been set up. All linkages between components must be resolved by this method, in order to prevent problems due to the order of definitions between components. This implies that each component must in turn call the same method for each child component. None of the other method calls defined by this interface are valid until after this call.
      Specified by:
      setLinkages in interface ILinkable
      Overrides:
      setLinkages in class PassThroughComponent
      Throws:
      JiBXException - if error in configuration

    • getAttributeMarshalMethod

      public String getAttributeMarshalMethod() throws JiBXException
      Description copied from interface: ITypeBinding
      Get the method which marshals attributes from an instance. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. There is no return value from the method.
      Specified by:
      getAttributeMarshalMethod in interface ITypeBinding
      Returns:
      attribute marshal method, or null if none
      Throws:
      JiBXException - on error in code generation

    • getAttributePresentTestMethod

      public String getAttributePresentTestMethod() throws JiBXException
      Description copied from interface: ITypeBinding
      Get the method which checks attributes to determine if an instance is present. This method takes the unmarshalling context as the only parameter. It returns true if an attribute of the mapping is found, false if not.
      Specified by:
      getAttributePresentTestMethod in interface ITypeBinding
      Returns:
      test method, or null if none
      Throws:
      JiBXException - on error in code generation

    • getAttributeUnmarshalMethod

      public String getAttributeUnmarshalMethod() throws JiBXException
      Description copied from interface: ITypeBinding
      Get the method which unmarshals attributes into an instance. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. The return value is the unmarshalled instance, which may not be the same instance as was passed as a parameter.
      Specified by:
      getAttributeUnmarshalMethod in interface ITypeBinding
      Returns:
      attribute unmarshal method, or null if none
      Throws:
      JiBXException - on error in code generation

    • getCompleteMethod

      public String getCompleteMethod() throws JiBXException
      Description copied from interface: ITypeBinding
      Get the method which handles unmarshalling completion. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. There is no return value from the method.
      Specified by:
      getCompleteMethod in interface ITypeBinding
      Returns:
      complete method, or null if none
      Throws:
      JiBXException - on error in code generation

    • getContentMarshalMethod

      public String getContentMarshalMethod() throws JiBXException
      Description copied from interface: ITypeBinding
      Get the method which marshals child elements and character data content from an instance. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. There is no return value from the method.
      Specified by:
      getContentMarshalMethod in interface ITypeBinding
      Returns:
      content marshal method, or null if none
      Throws:
      JiBXException - on error in code generation

    • getContentPresentTestMethod

      public String getContentPresentTestMethod() throws JiBXException
      Description copied from interface: ITypeBinding
      Get the method which checks child elements to determine if an instance is present. This method takes the unmarshalling context as the only parameter. It returns true if an attribute of the mapping is found, false if not.
      Specified by:
      getContentPresentTestMethod in interface ITypeBinding
      Returns:
      content test method, or null if none
      Throws:
      JiBXException - on error in code generation

    • getContentUnmarshalMethod

      public String getContentUnmarshalMethod() throws JiBXException
      Description copied from interface: ITypeBinding
      Get the method which unmarshals child elements and character data content into an instance. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. There is no return value from the method. The return value is the unmarshalled instance, which may not be the same instance as was passed as a parameter.
      Specified by:
      getContentUnmarshalMethod in interface ITypeBinding
      Returns:
      content unmarshal method, or null if none
      Throws:
      JiBXException - on error in code generation

    • getCreateMethod

      public String getCreateMethod() throws JiBXException
      Description copied from interface: ITypeBinding
      Get the method which creates an instance of the bound class if one does not already exist. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. If the passed reference is non-null that reference will simply be returned; otherwise, a new instance will be created and returned. This method also handles any appropriate pre-set processing for the instance.
      Specified by:
      getCreateMethod in interface ITypeBinding
      Returns:
      create method, or null if none
      Throws:
      JiBXException - on error in code generation

    • getPrepareMethod

      public String getPrepareMethod() throws JiBXException
      Description copied from interface: ITypeBinding
      Get the method which handles preparation for marshalling an instance. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. There is no return value from the method.
      Specified by:
      getPrepareMethod in interface ITypeBinding
      Returns:
      prepare method, or null if none
      Throws:
      JiBXException - on error in code generation

    • print

      public void print(int depth)
      Specified by:
      print in interface IComponent
      Overrides:
      print in class PassThroughComponent