Package org.jibx.binding.def
Class ObjectBinding
- java.lang.Object
-
- org.jibx.binding.def.PassThroughComponent
-
- org.jibx.binding.def.ObjectBinding
-
- All Implemented Interfaces:
IComponent
,IContextObj
,ILinkable
,ITypeBinding
public class ObjectBinding extends PassThroughComponent implements IComponent, IContextObj
Binding modifiers that apply to a class reference. This adds the methods used for handling binding operations to the object class (or a helper class), then generates calls to the added methods as this binding definition is used.- Author:
- Dennis M. Sosnoski
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
ATTR_PRESENCE_SUFFIX
private static java.lang.String
COMPLETE_SUFFIX
private static Type[]
EMPTY_ARGS
private static java.lang.String[]
FACTORY_HOOK_SIGNATURES
private static java.lang.String
GETSTACKTOP_SIGNATURE
private ClassItem
m_attributePresenceMethod
Generated attribute presence test method.private java.lang.String
m_attributePresenceName
Name for attribute presence test method (null
unless generation started).private boolean
m_checkedComplete
Checked for complete method needed flag.private boolean
m_checkedPrepare
Checked for prepare method needed flag.private BoundClass
m_class
Class linked to mapping.private java.lang.String
m_completeName
Complete method name (null
if none, or not yet checked).private IContainer
m_container
Containing binding definition structure.private ClassItem
m_contentPresenceMethod
Generated content presence test method.private java.lang.String
m_contentPresenceName
Name for content presence test method (null
unless generation started).private ClassFile
m_createClass
Type to be used for creating new instances.private java.lang.String
m_createName
Create method fully-qualified name (null
if not yet generated).private ClassItem
m_factoryMethod
Object factory method.private boolean
m_fakeContent
Fake content present flag, used when neither content nor attributes are present.private IComponent
m_idChild
Child supplying instance identifier value.private boolean
m_lockAttributeMarshal
Flag for recursion while generating attribute marshal.private boolean
m_lockAttributePresence
Flag for recursion while generating attribute presence test.private boolean
m_lockAttributeUnmarshal
Flag for recursion while generating attribute unmarshal.private boolean
m_lockContentMarshal
Flag for recursion while generating attribute marshal.private boolean
m_lockContentPresence
Flag for recursion while generating content presence test.private boolean
m_lockContentUnmarshal
Flag for recursion while generating attribute unmarshal.private boolean
m_mappingWrapper
Flag for dummy object binding, used when a concrete mapping just adds a name around an abstract mapping.private ClassItem
m_marshalAttributeMethod
Generated marshal attribute method.private java.lang.String
m_marshalAttributeName
Name for marshal attribute method (null
unless generation started).private ClassItem
m_marshalContentMethod
Generated marshal content method.private java.lang.String
m_marshalContentName
Name for marshal content method (null
unless generation started).private java.lang.String
m_marshalSignature
Signature used for marshal methods.private ClassItem
m_newInstanceMethod
Generated new instance method.private ClassItem
m_postSetMethod
Postset method for object.private ClassItem
m_preGetMethod
Preget method for object.private java.lang.String
m_prepareName
Prepare method name (null
if none, or not yet checked).private ClassItem
m_preSetMethod
Preset method for object.private ClassItem
m_unmarshalAttributeMethod
Generated unmarshal attribute method.private java.lang.String
m_unmarshalAttributeName
Name for unmarshal attribute method (null
unless generation started).private ClassItem
m_unmarshalContentMethod
Generated unmarshal content method.private java.lang.String
m_unmarshalContentName
Name for unmarshal content method (null
unless generation started).private java.lang.String
m_unmarshalSignature
Signature used for unmarshal methods.private static java.lang.String
MARSHAL_ATTR_SUFFIX
private static java.lang.String
MARSHAL_GETSTACKTOPMETHOD
private static java.lang.String[]
MARSHAL_HOOK_SIGNATURES
private static java.lang.String
MARSHAL_PARAMETER_NORET_SIGNATURE
private static java.lang.String
MARSHAL_POPOBJECTMETHOD
private static java.lang.String
MARSHAL_PUSHOBJECTMETHOD
private static java.lang.String
MARSHAL_SUFFIX
private static Type
MARSHALCONTEXT_TYPE
private static java.lang.String
MARSHALLING_CONTEXT
private static java.lang.String
NEWINSTANCE_SUFFIX
private static java.lang.String
POPOBJECT_SIGNATURE
private static java.lang.String
PREPARE_SUFFIX
private static java.lang.String
PRESENCE_SUFFIX
private static java.lang.String
PUSHOBJECT_SIGNATURE
private static Type[]
SETSOURCE_ARGS
private static java.lang.String
SETSOURCE_METHODNAME
private static java.lang.String
SOURCE_TRACKING_INTERFACE
private static java.lang.String
SOURCECOLUMN_FIELDNAME
private static java.lang.String
SOURCECOLUMN_METHODNAME
private static java.lang.String
SOURCEDOCUMENT_FIELDNAME
private static java.lang.String
SOURCELINE_FIELDNAME
private static java.lang.String
SOURCELINE_METHODNAME
private static java.lang.String
SOURCENAME_METHODNAME
private static java.lang.String
UNMARSHAL_ATTR_SUFFIX
private static java.lang.String
UNMARSHAL_GETSTACKTOPMETHOD
private static java.lang.String[]
UNMARSHAL_HOOK_SIGNATURES
private static java.lang.String
UNMARSHAL_PARAMETER_NORET_SIGNATURE
private static java.lang.String
UNMARSHAL_PARAMETER_SIGNATURE
private static java.lang.String
UNMARSHAL_POPOBJECTMETHOD
private static java.lang.String
UNMARSHAL_PUSHOBJECTMETHOD
private static java.lang.String
UNMARSHAL_PUSHTRACKEDOBJECTMETHOD
private static java.lang.String
UNMARSHAL_SUFFIX
private static Type[]
UNMARSHALCONTEXT_ARGS
private static Type
UNMARSHALCONTEXT_TYPE
private static java.lang.String
UNMARSHALLING_CONTEXT
-
Fields inherited from class org.jibx.binding.def.PassThroughComponent
m_component
-
-
Constructor Summary
Constructors Constructor Description ObjectBinding(IContainer contain, IContextObj objc, java.lang.String type, java.lang.String fact, java.lang.String pres, java.lang.String posts, java.lang.String pget, java.lang.String ctype)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
genAttributeMarshal(ContextMethodBuilder mb)
Generate attribute marshalling code.private void
genAttributePresenceMethod()
Generate attribute presence test method for object.void
genAttributeUnmarshal(ContextMethodBuilder mb)
Generate attribute unmarshalling code.void
genAttrPresentTest(ContextMethodBuilder mb)
Generate code to test for attribute present.private void
genCompleteMethod()
Generate unmarshalling complete method for object, if needed.void
genContentMarshal(ContextMethodBuilder mb)
Generate element or text marshalling code.private void
genContentPresenceMethod()
Generate content presence test method for object.void
genContentPresentTest(ContextMethodBuilder mb)
Generate code to test for content present.void
genContentUnmarshal(ContextMethodBuilder mb)
Generate element or text unmarshalling code.private void
genCreateMethod()
Generate create method for object.void
genLoadId(ContextMethodBuilder mb)
Generate code to load ID value of instance to stack.private void
genMarshalAttributeMethod()
Generate attribute marshal method for object.private void
genMarshalContentMethod()
Generate content marshal method for object.void
genNewInstance(ContextMethodBuilder mb)
Generate code to create new instance of object.private void
genPrepareMethod()
Generate prepare for marshalling method for object, if needed.private void
genTrackSourceCode()
Generate code to handle unmarshal source location tracking.private void
genUnmarshalAttributeMethod()
Generate attribute unmarshal method for object.private void
genUnmarshalContentMethod()
Generate content unmarshal method for object.private void
genUserMethodCall(boolean in, ClassItem method, ContextMethodBuilder mb)
Generate code for calling a user supplied method.java.lang.String
getAttributeMarshalMethod()
Get the method which marshals attributes from an instance.java.lang.String
getAttributePresentTestMethod()
Get the method which checks attributes to determine if an instance is present.java.lang.String
getAttributeUnmarshalMethod()
Get the method which unmarshals attributes into an instance.BoundClass
getBoundClass()
Get class linked to binding element.java.lang.String
getCompleteMethod()
Get the method which handles unmarshalling completion.java.lang.String
getContentMarshalMethod()
Get the method which marshals child elements and character data content from an instance.java.lang.String
getContentPresentTestMethod()
Get the method which checks child elements to determine if an instance is present.java.lang.String
getContentUnmarshalMethod()
Get the method which unmarshals child elements and character data content into an instance.java.lang.String
getCreateMethod()
Get the method which creates an instance of the bound class if one does not already exist.java.lang.String
getPrepareMethod()
Get the method which handles preparation for marshalling an instance.java.lang.String
getType()
Get type expected by component.boolean
hasContent()
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
isOptional()
Check if component is an optional item.void
print(int depth)
boolean
setIdChild(IComponent child)
Set ID property.void
setLinkages()
Establish and validate linkages between binding components.-
Methods inherited from class org.jibx.binding.def.PassThroughComponent
getWrapperName, hasAttribute, setWrappedComponent
-
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.IComponent
getWrapperName, hasAttribute
-
-
-
-
Field Detail
-
MARSHAL_HOOK_SIGNATURES
private static final java.lang.String[] MARSHAL_HOOK_SIGNATURES
-
FACTORY_HOOK_SIGNATURES
private static final java.lang.String[] FACTORY_HOOK_SIGNATURES
-
UNMARSHAL_HOOK_SIGNATURES
private static final java.lang.String[] UNMARSHAL_HOOK_SIGNATURES
-
UNMARSHAL_GETSTACKTOPMETHOD
private static final java.lang.String UNMARSHAL_GETSTACKTOPMETHOD
- See Also:
- Constant Field Values
-
MARSHAL_GETSTACKTOPMETHOD
private static final java.lang.String MARSHAL_GETSTACKTOPMETHOD
- See Also:
- Constant Field Values
-
GETSTACKTOP_SIGNATURE
private static final java.lang.String GETSTACKTOP_SIGNATURE
- See Also:
- Constant Field Values
-
MARSHALLING_CONTEXT
private static final java.lang.String MARSHALLING_CONTEXT
- See Also:
- Constant Field Values
-
UNMARSHALLING_CONTEXT
private static final java.lang.String UNMARSHALLING_CONTEXT
- See Also:
- Constant Field Values
-
UNMARSHAL_PARAMETER_SIGNATURE
private static final java.lang.String UNMARSHAL_PARAMETER_SIGNATURE
- See Also:
- Constant Field Values
-
UNMARSHAL_PUSHOBJECTMETHOD
private static final java.lang.String UNMARSHAL_PUSHOBJECTMETHOD
- See Also:
- Constant Field Values
-
UNMARSHAL_PUSHTRACKEDOBJECTMETHOD
private static final java.lang.String UNMARSHAL_PUSHTRACKEDOBJECTMETHOD
- See Also:
- Constant Field Values
-
MARSHAL_PUSHOBJECTMETHOD
private static final java.lang.String MARSHAL_PUSHOBJECTMETHOD
- See Also:
- Constant Field Values
-
PUSHOBJECT_SIGNATURE
private static final java.lang.String PUSHOBJECT_SIGNATURE
- See Also:
- Constant Field Values
-
UNMARSHAL_POPOBJECTMETHOD
private static final java.lang.String UNMARSHAL_POPOBJECTMETHOD
- See Also:
- Constant Field Values
-
MARSHAL_POPOBJECTMETHOD
private static final java.lang.String MARSHAL_POPOBJECTMETHOD
- See Also:
- Constant Field Values
-
POPOBJECT_SIGNATURE
private static final java.lang.String POPOBJECT_SIGNATURE
- See Also:
- Constant Field Values
-
UNMARSHAL_PARAMETER_NORET_SIGNATURE
private static final java.lang.String UNMARSHAL_PARAMETER_NORET_SIGNATURE
- See Also:
- Constant Field Values
-
MARSHAL_PARAMETER_NORET_SIGNATURE
private static final java.lang.String MARSHAL_PARAMETER_NORET_SIGNATURE
- See Also:
- Constant Field Values
-
NEWINSTANCE_SUFFIX
private static final java.lang.String NEWINSTANCE_SUFFIX
- See Also:
- Constant Field Values
-
PREPARE_SUFFIX
private static final java.lang.String PREPARE_SUFFIX
- See Also:
- Constant Field Values
-
COMPLETE_SUFFIX
private static final java.lang.String COMPLETE_SUFFIX
- See Also:
- Constant Field Values
-
ATTR_PRESENCE_SUFFIX
private static final java.lang.String ATTR_PRESENCE_SUFFIX
- See Also:
- Constant Field Values
-
UNMARSHAL_ATTR_SUFFIX
private static final java.lang.String UNMARSHAL_ATTR_SUFFIX
- See Also:
- Constant Field Values
-
MARSHAL_ATTR_SUFFIX
private static final java.lang.String MARSHAL_ATTR_SUFFIX
- See Also:
- Constant Field Values
-
PRESENCE_SUFFIX
private static final java.lang.String PRESENCE_SUFFIX
- See Also:
- Constant Field Values
-
UNMARSHAL_SUFFIX
private static final java.lang.String UNMARSHAL_SUFFIX
- See Also:
- Constant Field Values
-
MARSHAL_SUFFIX
private static final java.lang.String MARSHAL_SUFFIX
- See Also:
- Constant Field Values
-
UNMARSHALCONTEXT_TYPE
private static final Type UNMARSHALCONTEXT_TYPE
-
UNMARSHALCONTEXT_ARGS
private static final Type[] UNMARSHALCONTEXT_ARGS
-
MARSHALCONTEXT_TYPE
private static final Type MARSHALCONTEXT_TYPE
-
SOURCE_TRACKING_INTERFACE
private static final java.lang.String SOURCE_TRACKING_INTERFACE
- See Also:
- Constant Field Values
-
SETSOURCE_METHODNAME
private static final java.lang.String SETSOURCE_METHODNAME
- See Also:
- Constant Field Values
-
SETSOURCE_ARGS
private static final Type[] SETSOURCE_ARGS
-
SOURCEDOCUMENT_FIELDNAME
private static final java.lang.String SOURCEDOCUMENT_FIELDNAME
- See Also:
- Constant Field Values
-
SOURCELINE_FIELDNAME
private static final java.lang.String SOURCELINE_FIELDNAME
- See Also:
- Constant Field Values
-
SOURCECOLUMN_FIELDNAME
private static final java.lang.String SOURCECOLUMN_FIELDNAME
- See Also:
- Constant Field Values
-
SOURCENAME_METHODNAME
private static final java.lang.String SOURCENAME_METHODNAME
- See Also:
- Constant Field Values
-
SOURCELINE_METHODNAME
private static final java.lang.String SOURCELINE_METHODNAME
- See Also:
- Constant Field Values
-
SOURCECOLUMN_METHODNAME
private static final java.lang.String SOURCECOLUMN_METHODNAME
- See Also:
- Constant Field Values
-
EMPTY_ARGS
private static final Type[] EMPTY_ARGS
-
m_container
private final IContainer m_container
Containing binding definition structure.
-
m_class
private BoundClass m_class
Class linked to mapping.
-
m_factoryMethod
private final ClassItem m_factoryMethod
Object factory method.
-
m_preSetMethod
private final ClassItem m_preSetMethod
Preset method for object.
-
m_postSetMethod
private final ClassItem m_postSetMethod
Postset method for object.
-
m_preGetMethod
private final ClassItem m_preGetMethod
Preget method for object.
-
m_createClass
private final ClassFile m_createClass
Type to be used for creating new instances.
-
m_createName
private java.lang.String m_createName
Create method fully-qualified name (null
if not yet generated).
-
m_checkedComplete
private boolean m_checkedComplete
Checked for complete method needed flag.
-
m_checkedPrepare
private boolean m_checkedPrepare
Checked for prepare method needed flag.
-
m_completeName
private java.lang.String m_completeName
Complete method name (null
if none, or not yet checked).
-
m_prepareName
private java.lang.String m_prepareName
Prepare method name (null
if none, or not yet checked).
-
m_newInstanceMethod
private ClassItem m_newInstanceMethod
Generated new instance method.
-
m_lockAttributePresence
private boolean m_lockAttributePresence
Flag for recursion while generating attribute presence test.
-
m_lockContentPresence
private boolean m_lockContentPresence
Flag for recursion while generating content presence test.
-
m_lockAttributeUnmarshal
private boolean m_lockAttributeUnmarshal
Flag for recursion while generating attribute unmarshal.
-
m_lockAttributeMarshal
private boolean m_lockAttributeMarshal
Flag for recursion while generating attribute marshal.
-
m_lockContentUnmarshal
private boolean m_lockContentUnmarshal
Flag for recursion while generating attribute unmarshal.
-
m_lockContentMarshal
private boolean m_lockContentMarshal
Flag for recursion while generating attribute marshal.
-
m_attributePresenceName
private java.lang.String m_attributePresenceName
Name for attribute presence test method (null
unless generation started).
-
m_contentPresenceName
private java.lang.String m_contentPresenceName
Name for content presence test method (null
unless generation started).
-
m_unmarshalSignature
private java.lang.String m_unmarshalSignature
Signature used for unmarshal methods.
-
m_unmarshalAttributeName
private java.lang.String m_unmarshalAttributeName
Name for unmarshal attribute method (null
unless generation started).
-
m_unmarshalContentName
private java.lang.String m_unmarshalContentName
Name for unmarshal content method (null
unless generation started).
-
m_marshalSignature
private java.lang.String m_marshalSignature
Signature used for marshal methods.
-
m_marshalAttributeName
private java.lang.String m_marshalAttributeName
Name for marshal attribute method (null
unless generation started).
-
m_marshalContentName
private java.lang.String m_marshalContentName
Name for marshal content method (null
unless generation started).
-
m_attributePresenceMethod
private ClassItem m_attributePresenceMethod
Generated attribute presence test method.
-
m_contentPresenceMethod
private ClassItem m_contentPresenceMethod
Generated content presence test method.
-
m_unmarshalAttributeMethod
private ClassItem m_unmarshalAttributeMethod
Generated unmarshal attribute method.
-
m_unmarshalContentMethod
private ClassItem m_unmarshalContentMethod
Generated unmarshal content method.
-
m_marshalAttributeMethod
private ClassItem m_marshalAttributeMethod
Generated marshal attribute method.
-
m_marshalContentMethod
private ClassItem m_marshalContentMethod
Generated marshal content method.
-
m_idChild
private IComponent m_idChild
Child supplying instance identifier value.
-
m_fakeContent
private boolean m_fakeContent
Fake content present flag, used when neither content nor attributes are present.
-
m_mappingWrapper
private boolean m_mappingWrapper
Flag for dummy object binding, used when a concrete mapping just adds a name around an abstract mapping.
-
-
Constructor Detail
-
ObjectBinding
public ObjectBinding(IContainer contain, IContextObj objc, java.lang.String type, java.lang.String fact, java.lang.String pres, java.lang.String posts, java.lang.String pget, java.lang.String ctype) throws JiBXException
Constructor. This initializes the definition context to be the same as the parent's. Subclasses may change this definition context if appropriate.- Parameters:
contain
- containing binding definition componentobjc
- current object contexttype
- fully qualified class name for bound objectfact
- user new instance factory methodpres
- user preset method for unmarshallingposts
- user postset method for unmarshallingpget
- user preget method for marshallingctype
- type to use for creating new instance (null
if not specified)- Throws:
JiBXException
- if method not found
-
-
Method Detail
-
genUserMethodCall
private void genUserMethodCall(boolean in, ClassItem method, ContextMethodBuilder mb)
Generate code for calling a user supplied method. The object methods support three signature variations, with no parameters, with the marshalling or unmarshalling context, or with the owning object.- Parameters:
in
- flag for unmarshalling methodmethod
- information for method being calledmb
- method builder for generated code
-
genCreateMethod
private void genCreateMethod() throws JiBXException
Generate create method for object. The generated method matches theITypeBinding.getCreateMethod()
result signature.- Throws:
JiBXException
- if error in generating code
-
genPrepareMethod
private void genPrepareMethod() throws JiBXException
Generate prepare for marshalling method for object, if needed. The generated method matches theITypeBinding.getPrepareMethod()
result signature.- Throws:
JiBXException
- if error in generating code
-
genCompleteMethod
private void genCompleteMethod() throws JiBXException
Generate unmarshalling complete method for object, if needed. The generated method matches theITypeBinding.getCompleteMethod()
result signature.- Throws:
JiBXException
- if error in generating code
-
genTrackSourceCode
private void genTrackSourceCode()
Generate code to handle unmarshal source location tracking. This convenience method generates the member variables and method used to support setting the source location, the methods used to access the information, and also adds the appropriate interfaces to the class.
-
genAttributePresenceMethod
private void genAttributePresenceMethod() throws JiBXException
Generate attribute presence test method for object. The generated method matches theITypeBinding.getAttributePresentTestMethod()
result signature.- Throws:
JiBXException
- if error in configuration
-
genUnmarshalAttributeMethod
private void genUnmarshalAttributeMethod() throws JiBXException
Generate attribute unmarshal method for object. The generated method matches theITypeBinding.getAttributeUnmarshalMethod()
result signature.- Throws:
JiBXException
- if error in configuration
-
genMarshalAttributeMethod
private void genMarshalAttributeMethod() throws JiBXException
Generate attribute marshal method for object. The generated method matches theITypeBinding.getAttributeMarshalMethod()
result signature.- Throws:
JiBXException
- if error in configuration
-
genContentPresenceMethod
private void genContentPresenceMethod() throws JiBXException
Generate content presence test method for object. The generated method matches theITypeBinding.getContentPresentTestMethod()
result signature.- Throws:
JiBXException
- if error in configuration
-
genUnmarshalContentMethod
private void genUnmarshalContentMethod() throws JiBXException
Generate content unmarshal method for object. The generated method matches theITypeBinding.getContentUnmarshalMethod()
result signature.- Throws:
JiBXException
-
genMarshalContentMethod
private void genMarshalContentMethod() throws JiBXException
Generate content marshal method for object. The generated method matches theITypeBinding.getContentMarshalMethod()
result signature.- Throws:
JiBXException
-
getBoundClass
public BoundClass getBoundClass()
Description copied from interface:IContextObj
Get class linked to binding element.- Specified by:
getBoundClass
in interfaceIContextObj
- Returns:
- information for class linked by binding
-
setIdChild
public boolean setIdChild(IComponent child)
Description copied from interface:IContextObj
Set ID property. Tells the parent binding element that a particular child defines an ID property for the class linked to the parent.- Specified by:
setIdChild
in interfaceIContextObj
- Parameters:
child
- child defining the ID property- Returns:
true
if successful,false
if ID already defined
-
isOptional
public boolean isOptional()
Description copied from interface:IComponent
Check if component is an optional item.- Specified by:
isOptional
in interfaceIComponent
- Overrides:
isOptional
in classPassThroughComponent
- Returns:
true
if optional,false
if required
-
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 classPassThroughComponent
- Returns:
true
if one or more content 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 interfaceIComponent
- Overrides:
genAttrPresentTest
in classPassThroughComponent
- Parameters:
mb
- method builder- Throws:
JiBXException
- if configuration error
-
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 interfaceIComponent
- Overrides:
genContentPresentTest
in classPassThroughComponent
- 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 interfaceIComponent
- Overrides:
genAttributeUnmarshal
in classPassThroughComponent
- 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 interfaceIComponent
- Overrides:
genAttributeMarshal
in classPassThroughComponent
- Parameters:
mb
- method builder- Throws:
JiBXException
- if error in configuration
-
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 interfaceIComponent
- Overrides:
genContentUnmarshal
in classPassThroughComponent
- 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 interfaceIComponent
- Overrides:
genContentMarshal
in classPassThroughComponent
- Parameters:
mb
- method builder- Throws:
JiBXException
- if error in configuration
-
genNewInstance
public void genNewInstance(ContextMethodBuilder mb) throws JiBXException
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
- Overrides:
genNewInstance
in classPassThroughComponent
- Parameters:
mb
- method builder- Throws:
JiBXException
- if error in configuration
-
getType
public java.lang.String getType()
Description copied from interface:IComponent
Get type expected by component.- Specified by:
getType
in interfaceIComponent
- Overrides:
getType
in classPassThroughComponent
- 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
- Overrides:
hasId
in classPassThroughComponent
- 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 aString
).- Specified by:
genLoadId
in interfaceIComponent
- Overrides:
genLoadId
in classPassThroughComponent
- Parameters:
mb
- method builder- Throws:
JiBXException
- if configuration error
-
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 interfaceILinkable
- Overrides:
setLinkages
in classPassThroughComponent
- Throws:
JiBXException
- if error in configuration
-
getAttributeMarshalMethod
public java.lang.String getAttributeMarshalMethod() throws JiBXException
Description copied from interface:ITypeBinding
Get the method which marshals attributes from an instance. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. There is no return value from the method.- Specified by:
getAttributeMarshalMethod
in interfaceITypeBinding
- Returns:
- attribute marshal method, or
null
if none - Throws:
JiBXException
- on error in code generation
-
getAttributePresentTestMethod
public java.lang.String getAttributePresentTestMethod() throws JiBXException
Description copied from interface:ITypeBinding
Get the method which checks attributes to determine if an instance is present. This method takes the unmarshalling context as the only parameter. It returnstrue
if an attribute of the mapping is found,false
if not.- Specified by:
getAttributePresentTestMethod
in interfaceITypeBinding
- Returns:
- test method, or
null
if none - Throws:
JiBXException
- on error in code generation
-
getAttributeUnmarshalMethod
public java.lang.String getAttributeUnmarshalMethod() throws JiBXException
Description copied from interface:ITypeBinding
Get the method which unmarshals attributes into an instance. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. The return value is the unmarshalled instance, which may not be the same instance as was passed as a parameter.- Specified by:
getAttributeUnmarshalMethod
in interfaceITypeBinding
- Returns:
- attribute unmarshal method, or
null
if none - Throws:
JiBXException
- on error in code generation
-
getCompleteMethod
public java.lang.String getCompleteMethod() throws JiBXException
Description copied from interface:ITypeBinding
Get the method which handles unmarshalling completion. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. There is no return value from the method.- Specified by:
getCompleteMethod
in interfaceITypeBinding
- Returns:
- complete method, or
null
if none - Throws:
JiBXException
- on error in code generation
-
getContentMarshalMethod
public java.lang.String getContentMarshalMethod() throws JiBXException
Description copied from interface:ITypeBinding
Get the method which marshals child elements and character data content from an instance. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. There is no return value from the method.- Specified by:
getContentMarshalMethod
in interfaceITypeBinding
- Returns:
- content marshal method, or
null
if none - Throws:
JiBXException
- on error in code generation
-
getContentPresentTestMethod
public java.lang.String getContentPresentTestMethod() throws JiBXException
Description copied from interface:ITypeBinding
Get the method which checks child elements to determine if an instance is present. This method takes the unmarshalling context as the only parameter. It returnstrue
if an attribute of the mapping is found,false
if not.- Specified by:
getContentPresentTestMethod
in interfaceITypeBinding
- Returns:
- content test method, or
null
if none - Throws:
JiBXException
- on error in code generation
-
getContentUnmarshalMethod
public java.lang.String getContentUnmarshalMethod() throws JiBXException
Description copied from interface:ITypeBinding
Get the method which unmarshals child elements and character data content into an instance. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. There is no return value from the method. The return value is the unmarshalled instance, which may not be the same instance as was passed as a parameter.- Specified by:
getContentUnmarshalMethod
in interfaceITypeBinding
- Returns:
- content unmarshal method, or
null
if none - Throws:
JiBXException
- on error in code generation
-
getCreateMethod
public java.lang.String getCreateMethod() throws JiBXException
Description copied from interface:ITypeBinding
Get the method which creates an instance of the bound class if one does not already exist. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. If the passed reference is non-null
that reference will simply be returned; otherwise, a new instance will be created and returned. This method also handles any appropriate pre-set processing for the instance.- Specified by:
getCreateMethod
in interfaceITypeBinding
- Returns:
- create method, or
null
if none - Throws:
JiBXException
- on error in code generation
-
getPrepareMethod
public java.lang.String getPrepareMethod() throws JiBXException
Description copied from interface:ITypeBinding
Get the method which handles preparation for marshalling an instance. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. There is no return value from the method.- Specified by:
getPrepareMethod
in interfaceITypeBinding
- Returns:
- prepare method, or
null
if none - Throws:
JiBXException
- on error in code generation
-
print
public void print(int depth)
- Specified by:
print
in interfaceIComponent
- Overrides:
print
in classPassThroughComponent
-
-