Package org.jibx.binding.def

Class NestedCollection

java.lang.Object
org.jibx.binding.def.BindingBuilder.ContainerBase
org.jibx.binding.def.NestedBase
org.jibx.binding.def.NestedCollection
All Implemented Interfaces:
IComponent, IContainer, ILinkable
public class NestedCollection extends NestedBase
Collection binding definition. This handles one or more child components, which may be ordered or unordered.
Version:
1.0
Author:
Dennis M. Sosnoski

  • Field Details

  • Constructor Details

    • NestedCollection

      public NestedCollection(IContainer parent, IContextObj objc, boolean ord, boolean opt, boolean flex, String type, NestedCollection.CollectionLoad load, NestedCollection.CollectionStore store)
      Constructor.
      Parameters:
      parent - containing binding definition context
      objc - current object context
      ord - ordered content flag
      opt - optional component flag
      flex - flexible element handling flag
      type - fully qualified class name of values from collection (may be null, if child content present)
      load - collection load code generation strategy
      store - collection store code generation strategy

  • Method Details

    • getItemType

      public String getItemType()
      Get the collection item type.
      Returns:
      item type

    • 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.
      Parameters:
      mb - method builder

    • hasAttribute

      public boolean hasAttribute()
      Description copied from interface: IComponent
      Check if component defines one or more attribute values of the containing element.
      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.
      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.
      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.
      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
      Overrides:
      hasContent in class NestedBase
      Returns:
      true if one or more content values defined for containing element, false if not

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

    • hasId

      public boolean hasId()
      Description copied from interface: IComponent
      Check if component defines an ID value for instances of context object.
      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).
      Parameters:
      mb - 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
      Overrides:
      getWrapperName in class NestedBase
      Returns:
      component element name, null if no wrapper element

    • 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 NestedBase
      Returns:
      true if optional, false if required

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

    • print

      public void print(int depth)