Package org.jibx.binding.def
Class ElementWrapper
java.lang.Object
org.jibx.binding.def.ElementWrapper
- All Implemented Interfaces:
IComponent
,ILinkable
Component decorator for element definition. This associates an element name
with a component.
- Author:
- Dennis M. Sosnoski
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final IComponent
Property value binding component.private final DefinitionContext
Binding definition context.private boolean
Flag for value from collection (TODO: fix this in update).private final boolean
Flag for nillable element.private final NameDefinition
Element name information.private boolean
Flag for optional ignored element (TODO: fix this in update).private boolean
Flag for optional normal element (TODO: fix this in update).private boolean
Flag for optional structure object (TODO: fix this in update).protected static final String
protected static final String
protected static final String
private static final String
private static final String
private static final String
protected static final String
private static final String
protected static final String
protected static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
protected static final String
protected static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
-
Constructor Summary
ConstructorsConstructorDescriptionElementWrapper
(DefinitionContext defc, NameDefinition name, IComponent wrap, boolean nillable) 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 code to test for content present.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.getType()
Get type expected by component.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
setDirect
(boolean direct) Set the direct access flag.void
Establish and validate linkages between binding components.void
setOptionalIgnored
(boolean opt) Set flag for an optional ignored element.void
setOptionalNormal
(boolean opt) Set flag for an optional normal element.void
setStructureObject
(boolean opt) Set flag for an optional structure object.toString()
-
Field Details
-
UNMARSHAL_PARSESTARTATTRIBUTES
- See Also:
-
UNMARSHAL_PARSESTARTNOATTRIBUTES
- See Also:
-
UNMARSHAL_PARSEPASTSTART
- See Also:
-
UNMARSHAL_PARSESTARTSIGNATURE
- See Also:
-
UNMARSHAL_PARSEENDMETHOD
- See Also:
-
UNMARSHAL_PARSEENDSIGNATURE
- See Also:
-
UNMARSHAL_ISATMETHOD
- See Also:
-
UNMARSHAL_ISATSIGNATURE
- See Also:
-
UNMARSHAL_SKIPELEMENTMETHOD
- See Also:
-
UNMARSHAL_SKIPELEMENTSIGNATURE
- See Also:
-
MARSHAL_WRITESTARTNAMESPACES
- See Also:
-
MARSHAL_STARTNAMESPACESSIGNATURE
- See Also:
-
MARSHAL_WRITESTARTATTRIBUTES
- See Also:
-
MARSHAL_WRITESTARTNOATTRIBUTES
- See Also:
-
MARSHAL_WRITESTARTSIGNATURE
- See Also:
-
MARSHAL_CLOSESTARTCONTENT
- See Also:
-
MARSHAL_CLOSESTARTEMPTY
- See Also:
-
MARSHAL_CLOSESTARTSIGNATURE
- See Also:
-
MARSHAL_WRITEENDMETHOD
- See Also:
-
MARSHAL_WRITEENDSIGNATURE
- See Also:
-
UNMARSHAL_PARSE_TO_START_NAME
- See Also:
-
UNMARSHAL_PARSE_TO_START_SIGNATURE
- See Also:
-
UNMARSHAL_ATTRIBUTE_BOOLEAN_NAME
- See Also:
-
UNMARSHAL_ATTRIBUTE_BOOLEAN_SIGNATURE
- See Also:
-
UNMARSHAL_SKIP_NAME
- See Also:
-
UNMARSHAL_SKIP_SIGNATURE
- See Also:
-
MARSHAL_STARTTAG_ATTRIBUTES
- See Also:
-
MARSHAL_STARTTAG_SIGNATURE
- See Also:
-
MARSHAL_CLOSESTART_EMPTY
- See Also:
-
MARSHAL_CLOSESTART_EMPTY_SIGNATURE
- See Also:
-
MARSHAL_ATTRIBUTE
- See Also:
-
MARSHAL_SIGNATURE
- See Also:
-
MARSHALLING_CONTEXT
- See Also:
-
UNMARSHALLING_CONTEXT
- See Also:
-
m_component
Property value binding component. -
m_defContext
Binding definition context. -
m_name
Element name information. -
m_isNillable
private final boolean m_isNillableFlag for nillable element. -
m_directAccess
private boolean m_directAccessFlag for value from collection (TODO: fix this in update). -
m_optionalIgnored
private boolean m_optionalIgnoredFlag for optional ignored element (TODO: fix this in update). -
m_optionalNormal
private boolean m_optionalNormalFlag for optional normal element (TODO: fix this in update). -
m_structureObject
private boolean m_structureObjectFlag for optional structure object (TODO: fix this in update).
-
-
Constructor Details
-
ElementWrapper
public ElementWrapper(DefinitionContext defc, NameDefinition name, IComponent wrap, boolean nillable) Constructor.- Parameters:
defc
- definition context for this componentname
- element name definitionwrap
- wrapped binding component (may benull
, in the case of a throwaway component)nillable
- flag for nillable element
-
-
Method Details
-
setDirect
public void setDirect(boolean direct) Set the direct access flag. This controls a variation in the code generation to handle values loaded from a collection.- Parameters:
direct
-true
if direct access from collection,false
if not
-
setOptionalIgnored
public void setOptionalIgnored(boolean opt) Set flag for an optional ignored element.- Parameters:
opt
-true
if optional ignored element,false
if not
-
setStructureObject
public void setStructureObject(boolean opt) Set flag for an optional structure object.- Parameters:
opt
-true
if optional structure object,false
if not
-
setOptionalNormal
public void setOptionalNormal(boolean opt) Set flag for an optional normal element.- Parameters:
opt
-true
if optional normal element,false
if not
-
isOptional
public boolean isOptional()Description copied from interface:IComponent
Check if component is an optional item.- Specified by:
isOptional
in interfaceIComponent
- 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 interfaceIComponent
- 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.- Specified by:
genAttrPresentTest
in interfaceIComponent
- 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.- Specified by:
genAttributeUnmarshal
in interfaceIComponent
- 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.- Specified by:
genAttributeMarshal
in interfaceIComponent
- 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
- Returns:
true
if one or more content values defined for containing element,false
if not
-
genContentPresentTest
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 interfaceIComponent
- Parameters:
mb
- method builder- Throws:
JiBXException
- if configuration error
-
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.- Specified by:
genContentUnmarshal
in interfaceIComponent
- 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.- Specified by:
genContentMarshal
in interfaceIComponent
- Parameters:
mb
- method builder- Throws:
JiBXException
- if error in configuration
-
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.- Specified by:
genNewInstance
in interfaceIComponent
- Parameters:
mb
- method builder- Throws:
JiBXException
- if error in configuration
-
getType
Description copied from interface:IComponent
Get type expected by component.- Specified by:
getType
in interfaceIComponent
- 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 interfaceIComponent
- 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
).- Specified by:
genLoadId
in interfaceIComponent
- 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
- Returns:
- component element name,
null
if no wrapper element
-
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.- Specified by:
setLinkages
in interfaceILinkable
- Throws:
JiBXException
- if error in configuration
-
print
public void print(int depth) - Specified by:
print
in interfaceIComponent
-
toString
-