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
Collection binding definition. This handles one or more child components,
which may be ordered or unordered.
- Version:
- 1.0
- Author:
- Dennis M. Sosnoski
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
Collection item store strategy for collection with add method.(package private) static class
Collection item load strategy for array.(package private) static class
Collection item store strategy for array.(package private) static class
Base class for collection item load strategy.(package private) static class
Base class for collection item load strategy.(package private) static class
Base class for collection item store strategy.(package private) static class
Collection item load strategy for collection with items accessed by index number.(package private) static class
Collection item store strategy for collection with items set by index number.(package private) static class
Collection item load strategy for collection with items accessed by iterator or enumeration. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String
private static final String
private static final String
private static final String
private final boolean
Optional component flag.private final String
Fully qualified class name of values from collection.private final NestedCollection.CollectionLoad
Strategy for generating code to load item from collection.private final NestedCollection.CollectionStore
Strategy for generating code to store item to collection.private static final String
private static final String
private static final String
private static final String
Fields inherited from class org.jibx.binding.def.NestedBase
m_attributes, m_contents, m_isFlexible, m_isOrdered
Fields inherited from class org.jibx.binding.def.BindingBuilder.ContainerBase
m_accessLevel, m_autoLink, m_container, m_nameStyle, m_stripPrefix, m_stripSuffix, m_styleDefault
-
Constructor Summary
ConstructorsConstructorDescriptionNestedCollection
(IContainer parent, IContextObj objc, boolean ord, boolean opt, boolean flex, String type, NestedCollection.CollectionLoad load, NestedCollection.CollectionStore store) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Generate attribute marshalling code.void
Generate attribute unmarshalling code.void
Generate code to test for attribute present.void
Generate element or text marshalling code.void
Generate element or text unmarshalling code.void
Generate code to load ID value of instance to stack.void
Generate code to create new instance of object.Get the collection item type.Get element wrapper name.boolean
Check if component defines one or more attribute values of the containing element.boolean
Check if component defines one or more elements or text values as children of the containing element.boolean
hasId()
Check if component defines an ID value for instances of context object.boolean
Check if component is an optional item.void
print
(int depth) void
Establish and validate linkages between binding components.Methods inherited from class org.jibx.binding.def.NestedBase
addComponent, genContentPresentTest, getAttributes, getBindingRoot, getContents, getDefinitionContext, getType, hasNamespaces, isContentOrdered, isFlexible, setObjectContext
Methods inherited from class org.jibx.binding.def.BindingBuilder.ContainerBase
getStyleDefault, unmarshal
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.jibx.binding.def.IContainer
getStyleDefault
-
Field Details
-
GROWARRAY_METHOD
- See Also:
-
GROWARRAY_SIGNATURE
- See Also:
-
RESIZEARRAY_METHOD
- See Also:
-
RESIZEARRAY_SIGNATURE
- See Also:
-
CHECK_ISSTART_NAME
- See Also:
-
CHECK_ISSTART_SIGNATURE
- See Also:
-
SKIP_ELEMENT_NAME
- See Also:
-
SKIP_ELEMENT_SIGNATURE
- See Also:
-
m_itemType
Fully qualified class name of values from collection. -
m_loadStrategy
Strategy for generating code to load item from collection. -
m_storeStrategy
Strategy for generating code to store item to collection. -
m_isOptional
private final boolean m_isOptionalOptional component flag.
-
-
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 contextobjc
- current object contextord
- ordered content flagopt
- optional component flagflex
- flexible element handling flagtype
- fully qualified class name of values from collection (may benull
, if child content present)load
- collection load code generation strategystore
- collection store code generation strategy
-
-
Method Details
-
getItemType
Get the collection item type.- Returns:
- item type
-
genNewInstance
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
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
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
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 toILinkable.setLinkages()
.- Specified by:
hasContent
in interfaceIComponent
- Overrides:
hasContent
in classNestedBase
- Returns:
true
if one or more content values defined for containing element,false
if not
-
genContentUnmarshal
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
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
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 aString
).- Parameters:
mb
- method builder- Throws:
JiBXException
- if configuration error
-
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 interfaceIComponent
- Overrides:
getWrapperName
in classNestedBase
- 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 interfaceIComponent
- Overrides:
isOptional
in classNestedBase
- Returns:
true
if optional,false
if required
-
setLinkages
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)
-