Package org.jibx.binding.def

Class ValueChild

  • All Implemented Interfaces:
    IComponent, ILinkable
    public class ValueChild
extends java.lang.Object
implements IComponent
    Attribute or simple content value definition from binding. This organizes information for anything that can be converted to and from a simple String. Content values include both elements with only character data content and text, as character data content or CDATA sections.
    Author:
    Dennis M. Sosnoski

    • Field Detail

      • BACKFILL_SUFFIX

        private static final java.lang.String BACKFILL_SUFFIX
        Prefix used for backfill classes.
        See Also:
        Constant Field Values

      • BACKFILL_INTERFACES

        private static final java.lang.String[] BACKFILL_INTERFACES

      • BACKFILL_METHODNAME

        private static final java.lang.String BACKFILL_METHODNAME
        See Also:
        Constant Field Values

      • BACKFILL_METHODARGS

        private static final Type[] BACKFILL_METHODARGS

      • CHECK_ELEMENT_NAME

        private static final java.lang.String CHECK_ELEMENT_NAME
        See Also:
        Constant Field Values

      • CHECK_ATTRIBUTE_NAME

        private static final java.lang.String CHECK_ATTRIBUTE_NAME
        See Also:
        Constant Field Values

      • UNMARSHAL_DEFREF_ATTR_NAME

        private static final java.lang.String UNMARSHAL_DEFREF_ATTR_NAME
        See Also:
        Constant Field Values

      • UNMARSHAL_DEFREF_ELEM_NAME

        private static final java.lang.String UNMARSHAL_DEFREF_ELEM_NAME
        See Also:
        Constant Field Values

      • UNMARSHAL_FWDREF_ATTR_NAME

        private static final java.lang.String UNMARSHAL_FWDREF_ATTR_NAME
        See Also:
        Constant Field Values

      • UNMARSHAL_FWDREF_ELEM_NAME

        private static final java.lang.String UNMARSHAL_FWDREF_ELEM_NAME
        See Also:
        Constant Field Values

      • UNMARSHAL_DEFREF_SIGNATURE

        private static final java.lang.String UNMARSHAL_DEFREF_SIGNATURE
        See Also:
        Constant Field Values

      • REGISTER_BACKFILL_NAME

        private static final java.lang.String REGISTER_BACKFILL_NAME
        See Also:
        Constant Field Values

      • REGISTER_BACKFILL_SIGNATURE

        private static final java.lang.String REGISTER_BACKFILL_SIGNATURE
        See Also:
        Constant Field Values

      • DEFINE_ID_SIGNATURE

        private static final java.lang.String DEFINE_ID_SIGNATURE
        See Also:
        Constant Field Values

      • UNMARSHAL_REQ_ATTRIBUTE

        protected static final java.lang.String UNMARSHAL_REQ_ATTRIBUTE
        See Also:
        Constant Field Values

      • UNMARSHAL_REQ_SIGNATURE

        protected static final java.lang.String UNMARSHAL_REQ_SIGNATURE
        See Also:
        Constant Field Values

      • UNMARSHAL_TEXT_NAME

        private static final java.lang.String UNMARSHAL_TEXT_NAME
        See Also:
        Constant Field Values

      • UNMARSHAL_TEXT_SIGNATURE

        private static final java.lang.String UNMARSHAL_TEXT_SIGNATURE
        See Also:
        Constant Field Values

      • UNMARSHAL_ELEMENT_TEXT_NAME

        private static final java.lang.String UNMARSHAL_ELEMENT_TEXT_NAME
        See Also:
        Constant Field Values

      • UNMARSHAL_ELEMENT_TEXT_SIGNATURE

        private static final java.lang.String UNMARSHAL_ELEMENT_TEXT_SIGNATURE
        See Also:
        Constant Field Values

      • UNMARSHAL_PARSE_IF_START_NAME

        private static final java.lang.String UNMARSHAL_PARSE_IF_START_NAME
        See Also:
        Constant Field Values

      • UNMARSHAL_PARSE_IF_START_SIGNATURE

        private static final java.lang.String UNMARSHAL_PARSE_IF_START_SIGNATURE
        See Also:
        Constant Field Values

      • UNMARSHAL_PARSE_TO_START_NAME

        private static final java.lang.String UNMARSHAL_PARSE_TO_START_NAME
        See Also:
        Constant Field Values

      • UNMARSHAL_PARSE_TO_START_SIGNATURE

        private static final java.lang.String UNMARSHAL_PARSE_TO_START_SIGNATURE
        See Also:
        Constant Field Values

      • UNMARSHAL_PARSE_PAST_END_NAME

        private static final java.lang.String UNMARSHAL_PARSE_PAST_END_NAME
        See Also:
        Constant Field Values

      • UNMARSHAL_PARSE_PAST_END_SIGNATURE

        private static final java.lang.String UNMARSHAL_PARSE_PAST_END_SIGNATURE
        See Also:
        Constant Field Values

      • UNMARSHAL_SKIPELEMENTMETHOD

        private static final java.lang.String UNMARSHAL_SKIPELEMENTMETHOD
        See Also:
        Constant Field Values

      • UNMARSHAL_SKIPELEMENTSIGNATURE

        private static final java.lang.String UNMARSHAL_SKIPELEMENTSIGNATURE
        See Also:
        Constant Field Values

      • MARSHAL_TEXT_NAME

        private static final java.lang.String MARSHAL_TEXT_NAME
        See Also:
        Constant Field Values

      • MARSHAL_CDATA_NAME

        private static final java.lang.String MARSHAL_CDATA_NAME
        See Also:
        Constant Field Values

      • MARSHAL_TEXT_SIGNATURE

        private static final java.lang.String MARSHAL_TEXT_SIGNATURE
        See Also:
        Constant Field Values

      • UNMARSHALLING_THROWEXCEPTION_METHOD

        private static final java.lang.String UNMARSHALLING_THROWEXCEPTION_METHOD
        See Also:
        Constant Field Values

      • UNMARSHALLING_THROWEXCEPTION_SIGNATURE

        private static final java.lang.String UNMARSHALLING_THROWEXCEPTION_SIGNATURE
        See Also:
        Constant Field Values

      • MARSHAL_ATTRIBUTE

        protected static final java.lang.String MARSHAL_ATTRIBUTE
        See Also:
        Constant Field Values

      • MARSHAL_ELEMENT

        protected static final java.lang.String MARSHAL_ELEMENT
        See Also:
        Constant Field Values

      • MARSHAL_SIGNATURE

        protected static final java.lang.String MARSHAL_SIGNATURE
        See Also:
        Constant Field Values

      • MARSHAL_STARTTAG_ATTRIBUTES

        protected static final java.lang.String MARSHAL_STARTTAG_ATTRIBUTES
        See Also:
        Constant Field Values

      • MARSHAL_STARTTAG_SIGNATURE

        protected static final java.lang.String MARSHAL_STARTTAG_SIGNATURE
        See Also:
        Constant Field Values

      • MARSHAL_CLOSESTART_EMPTY

        protected static final java.lang.String MARSHAL_CLOSESTART_EMPTY
        See Also:
        Constant Field Values

      • MARSHAL_CLOSESTART_EMPTY_SIGNATURE

        protected static final java.lang.String MARSHAL_CLOSESTART_EMPTY_SIGNATURE
        See Also:
        Constant Field Values

      • UNMARSHAL_ATTRIBUTE_BOOLEAN_NAME

        protected static final java.lang.String UNMARSHAL_ATTRIBUTE_BOOLEAN_NAME
        See Also:
        Constant Field Values

      • UNMARSHAL_ATTRIBUTE_BOOLEAN_SIGNATURE

        protected static final java.lang.String UNMARSHAL_ATTRIBUTE_BOOLEAN_SIGNATURE
        See Also:
        Constant Field Values

      • m_container

        private final IContainer m_container
        Containing binding definition structure.

      • m_objContext

        private final IContextObj m_objContext
        Containing object context.

      • m_valueStyle

        private final int m_valueStyle
        Value style code.

      • m_constantValue

        private final java.lang.String m_constantValue
        Constant value.

      • m_identType

        private final int m_identType
        Ident type code.

      • m_name

        private final NameDefinition m_name
        Attribute or element name information.

      • m_type

        private final java.lang.String m_type
        Fully qualified name of type.

      • m_isNillable

        private final boolean m_isNillable
        Nillable element flag.

      • m_conversion

        private final StringConversion m_conversion
        Conversion handling for value.

      • m_idRefMap

        private IMapping m_idRefMap
        Mapping definition for object class supplying identifier.

    • Constructor Detail

      • ValueChild

        public ValueChild​(IContainer contain,
                  IContextObj objc,
                  NameDefinition name,
                  PropertyDefinition prop,
                  StringConversion conv,
                  int style,
                  int ident,
                  java.lang.String constant,
                  boolean nillable)
        Constructor. Saves the context information for later use.
        Parameters:
        contain - containing binding definition structure
        objc - containing object context
        name - element or attribute name information (may be null)
        prop - property reference information
        conv - string conversion handler
        style - value style code
        ident - identifier type code
        constant - value for constant
        nillable - nillable element flag

    • Method Detail

      • createBackfillClass

        private ClassFile createBackfillClass()
                               throws JiBXException
        Create backfill handler class if it does not already exist. This either looks up the existing backfill handler class or creates a new one specifically for this value.
        Returns:
        backfill handler class for value
        Throws:
        JiBXException - if error in configuration

      • genParseIdRef

        private void genParseIdRef​(ContextMethodBuilder mb)
                    throws JiBXException
        Generate unmarshalling code for object identifier reference. The code generated by this method assumes the unmarshalling context and name have already been loaded to the stack, and these are consumed by the code.
        Parameters:
        mb - method builder
        Throws:
        JiBXException - if error in configuration

      • genIfPresentTest

        public void genIfPresentTest​(UnmarshalBuilder mb)
                      throws JiBXException
        Generate test if present code. This generates code that tests if the child is present, leaving the result of the test (zero if missing, nonzero if present) on the stack.
        Parameters:
        mb - unmarshal method builder
        Throws:
        JiBXException - if configuration error

      • genUnmarshal

        private void genUnmarshal​(ContextMethodBuilder mb)
                   throws JiBXException
        Generate unmarshalling code. This internal method generates the necessary code for handling the unmarshalling operation. The code generated by this method restores the stack to the original state when done.
        Parameters:
        mb - method builder
        Throws:
        JiBXException - if error in configuration

      • genMarshal

        private void genMarshal​(ContextMethodBuilder mb)
                 throws JiBXException
        Generate marshalling code. This internal method generates the necessary code for handling the marshalling operation. The code generated by this method restores the stack to the original state when done.
        Parameters:
        mb - method builder
        Throws:
        JiBXException - if error in configuration

      • getPropertyName

        public java.lang.String getPropertyName()
        Get property name. If the child has an associated property this returns the name of that property.
        Returns:
        name for child property

      • isImplicit

        public boolean isImplicit()
        Check if implicit.
        Returns:
        true if implicit, false if not

      • switchProperty

        public void switchProperty()
        Switch property from "this" to "implicit".

      • 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)
                        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
        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
        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
        Parameters:
        mb - method builder
        Throws:
        JiBXException - if error in configuration

      • 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 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:
        JiBXException - if configuration error

      • 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
        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
        Parameters:
        mb - method builder
        Throws:
        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 java.lang.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 mub)
               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
        Parameters:
        mub - method builder
        Throws:
        JiBXException - if configuration error

      • 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 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:
        JiBXException - if error in configuration

      • print

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