Package org.jibx.binding.def

Class DirectObject

  • All Implemented Interfaces:
    IComponent, ILinkable
    public class DirectObject
extends Object
implements IComponent
    Linkage to object with supplied marshaller and unmarshaller. This provides methods used to generate code for calling the supplied classes.
    Author:
    Dennis M. Sosnoski

    • Constructor Detail

      • DirectObject

        public DirectObject​(IContainer parent,
                    DefinitionContext defc,
                    ClassFile target,
                    boolean abs,
                    ClassFile mcf,
                    ClassFile ucf,
                    String mapname,
                    NameDefinition name,
                    String factname)
             throws org.jibx.runtime.JiBXException
        Constructor.
        Parameters:
        parent - containing binding definition structure
        defc - active definitions context
        target - class handled by this binding
        abs - abstract mapping flag
        mcf - marshaller class information (null if input only binding)
        ucf - unmarshaller class information (null if output only binding)
        mapname - mapping name in binding definition tables (null if to be constructed)
        name - element name information (null if no element name)
        factname - binding factory name for marshalling namespace translation (null if no namespace translation)
        Throws:
        org.jibx.runtime.JiBXException - if configuration error

    • Method Detail

      • genTestPresent

        public void genTestPresent​(ContextMethodBuilder mb)
                    throws org.jibx.runtime.JiBXException
        Generate presence test code for this mapping. The generated code finds the unmarshaller and calls the test method, leaving the result on the stack.
        Parameters:
        mb - method builder
        Throws:
        org.jibx.runtime.JiBXException - if error in generating code

      • genUnmarshal

        public void genUnmarshal​(ContextMethodBuilder mb)
                  throws org.jibx.runtime.JiBXException
        Generate unmarshalling code for this mapping. The generated code finds and calls the unmarshaller with the object to be unmarshaller (which needs to be loaded on the stack by the code prior to this call, but may be null). The unmarshalled object (or null in the case of a missing optional item) is left on the stack after this call. The calling method generally needs to cast this object reference to the appropriate type before using it.
        Parameters:
        mb - method builder
        Throws:
        org.jibx.runtime.JiBXException - if error in generating code

      • genMarshal

        public void genMarshal​(ContextMethodBuilder mb)
                throws org.jibx.runtime.JiBXException
        Generate marshalling code for this mapping. The generated code finds and calls the marshaller, passing the object to be marshalled (which should have been loaded to the stack by the prior generated code)..
        Parameters:
        mb - method builder
        Throws:
        org.jibx.runtime.JiBXException - if error in configuration

      • getTargetClass

        public ClassFile getTargetClass()
        Get target class for mapping.
        Returns:
        target class information

      • getMarshaller

        public ClassFile getMarshaller()
                        throws org.jibx.runtime.JiBXException
        Get marshaller class used for mapping. If a name has been supplied the actual marshaller class is created by extending the base class the first time this method is called.
        Returns:
        marshaller class information
        Throws:
        org.jibx.runtime.JiBXException - if error in transformation

      • getUnmarshaller

        public ClassFile getUnmarshaller()
                          throws org.jibx.runtime.JiBXException
        Get unmarshaller class used for mapping. If a name has been supplied the actual unmarshaller class is created by extending the base class the first time this method is called.
        Returns:
        unmarshaller class information
        Throws:
        org.jibx.runtime.JiBXException - if error in transformation

      • isOptional

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

      • hasAttribute

        public boolean hasAttribute()
        Description copied from interface: IComponent
        Check if component defines one or more attribute values of the containing element.
        Specified by:
        hasAttribute in interface IComponent
        Returns:
        true if one or more attribute values defined for containing element, false if not

      • genAttrPresentTest

        public void genAttrPresentTest​(ContextMethodBuilder mb)
        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
        Parameters:
        mb - method builder

      • genAttributeUnmarshal

        public void genAttributeUnmarshal​(ContextMethodBuilder mb)
        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
        Parameters:
        mb - method builder

      • genAttributeMarshal

        public void genAttributeMarshal​(ContextMethodBuilder mb)
        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
        Parameters:
        mb - method builder

      • 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
        Returns:
        true if one or more content values defined for containing element, false if not

      • genContentPresentTest

        public void genContentPresentTest​(ContextMethodBuilder mb)
                           throws org.jibx.runtime.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
        Parameters:
        mb - method builder
        Throws:
        org.jibx.runtime.JiBXException - if configuration error

      • genContentUnmarshal

        public void genContentUnmarshal​(ContextMethodBuilder mb)
                         throws org.jibx.runtime.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
        Parameters:
        mb - method builder
        Throws:
        org.jibx.runtime.JiBXException - if error in configuration

      • genContentMarshal

        public void genContentMarshal​(ContextMethodBuilder mb)
                       throws org.jibx.runtime.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
        Parameters:
        mb - method builder
        Throws:
        org.jibx.runtime.JiBXException - if error in configuration

      • genNewInstance

        public void genNewInstance​(ContextMethodBuilder mb)
        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
        Parameters:
        mb - method builder

      • getType

        public String getType()
        Description copied from interface: IComponent
        Get type expected by component.
        Specified by:
        getType in interface IComponent
        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
        Returns:
        true if ID value defined for instances, false if not

      • genLoadId

        public void genLoadId​(ContextMethodBuilder mb)
        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
        Parameters:
        mb - method builder

      • getWrapperName

        public NameDefinition getWrapperName()
        Description copied from interface: IComponent
        Get element wrapper name. If the component defines an element as the container for content, this returns the name information for that element.
        Specified by:
        getWrapperName in interface IComponent
        Returns:
        component element name, null if no wrapper element

      • setLinkages

        public void setLinkages()
                 throws org.jibx.runtime.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
        Throws:
        org.jibx.runtime.JiBXException - if error in configuration

      • print

        public void print​(int depth)
        Specified by:
        print in interface IComponent