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
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
FieldsModifier and TypeFieldDescriptionprivate static final String
private static final String
private static final Type[]
private static final String[]
private static final String
private ClassItem
Generated attribute presence test method.private String
Name for attribute presence test method (null
unless generation started).private boolean
Checked for complete method needed flag.private boolean
Checked for prepare method needed flag.private BoundClass
Class linked to mapping.private String
Complete method name (null
if none, or not yet checked).private final IContainer
Containing binding definition structure.private ClassItem
Generated content presence test method.private String
Name for content presence test method (null
unless generation started).private final ClassFile
Type to be used for creating new instances.private String
Create method fully-qualified name (null
if not yet generated).private final ClassItem
Object factory method.private boolean
Fake content present flag, used when neither content nor attributes are present.private IComponent
Child supplying instance identifier value.private boolean
Flag for recursion while generating attribute marshal.private boolean
Flag for recursion while generating attribute presence test.private boolean
Flag for recursion while generating attribute unmarshal.private boolean
Flag for recursion while generating attribute marshal.private boolean
Flag for recursion while generating content presence test.private boolean
Flag for recursion while generating attribute unmarshal.private boolean
Flag for dummy object binding, used when a concrete mapping just adds a name around an abstract mapping.private ClassItem
Generated marshal attribute method.private String
Name for marshal attribute method (null
unless generation started).private ClassItem
Generated marshal content method.private String
Name for marshal content method (null
unless generation started).private String
Signature used for marshal methods.private ClassItem
Generated new instance method.private final ClassItem
Postset method for object.private final ClassItem
Preget method for object.private String
Prepare method name (null
if none, or not yet checked).private final ClassItem
Preset method for object.private ClassItem
Generated unmarshal attribute method.private String
Name for unmarshal attribute method (null
unless generation started).private ClassItem
Generated unmarshal content method.private String
Name for unmarshal content method (null
unless generation started).private String
Signature used for unmarshal methods.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 Type
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 Type[]
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
private static final String
private static final String
private static final Type[]
private static final Type
private static final String
Fields inherited from class org.jibx.binding.def.PassThroughComponent
m_component
-
Constructor Summary
ConstructorsConstructorDescriptionObjectBinding
(IContainer contain, IContextObj objc, String type, String fact, String pres, String posts, String pget, String ctype) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Generate attribute marshalling code.private void
Generate attribute presence test method for object.void
Generate attribute unmarshalling code.void
Generate code to test for attribute present.private void
Generate unmarshalling complete method for object, if needed.void
Generate element or text marshalling code.private void
Generate content presence test method for object.void
Generate code to test for content present.void
Generate element or text unmarshalling code.private void
Generate create method for object.void
Generate code to load ID value of instance to stack.private void
Generate attribute marshal method for object.private void
Generate content marshal method for object.void
Generate code to create new instance of object.private void
Generate prepare for marshalling method for object, if needed.private void
Generate code to handle unmarshal source location tracking.private void
Generate attribute unmarshal method for object.private void
Generate content unmarshal method for object.private void
genUserMethodCall
(boolean in, ClassItem method, ContextMethodBuilder mb) Generate code for calling a user supplied method.Get the method which marshals attributes from an instance.Get the method which checks attributes to determine if an instance is present.Get the method which unmarshals attributes into an instance.Get class linked to binding element.Get the method which handles unmarshalling completion.Get the method which marshals child elements and character data content from an instance.Get the method which checks child elements to determine if an instance is present.Get the method which unmarshals child elements and character data content into an instance.Get the method which creates an instance of the bound class if one does not already exist.Get the method which handles preparation for marshalling an instance.getType()
Get type expected by component.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) boolean
setIdChild
(IComponent child) Set ID property.void
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 Details
-
MARSHAL_HOOK_SIGNATURES
-
FACTORY_HOOK_SIGNATURES
-
UNMARSHAL_HOOK_SIGNATURES
-
UNMARSHAL_GETSTACKTOPMETHOD
- See Also:
-
MARSHAL_GETSTACKTOPMETHOD
- See Also:
-
GETSTACKTOP_SIGNATURE
- See Also:
-
MARSHALLING_CONTEXT
- See Also:
-
UNMARSHALLING_CONTEXT
- See Also:
-
UNMARSHAL_PARAMETER_SIGNATURE
- See Also:
-
UNMARSHAL_PUSHOBJECTMETHOD
- See Also:
-
UNMARSHAL_PUSHTRACKEDOBJECTMETHOD
- See Also:
-
MARSHAL_PUSHOBJECTMETHOD
- See Also:
-
PUSHOBJECT_SIGNATURE
- See Also:
-
UNMARSHAL_POPOBJECTMETHOD
- See Also:
-
MARSHAL_POPOBJECTMETHOD
- See Also:
-
POPOBJECT_SIGNATURE
- See Also:
-
UNMARSHAL_PARAMETER_NORET_SIGNATURE
- See Also:
-
MARSHAL_PARAMETER_NORET_SIGNATURE
- See Also:
-
NEWINSTANCE_SUFFIX
- See Also:
-
PREPARE_SUFFIX
- See Also:
-
COMPLETE_SUFFIX
- See Also:
-
ATTR_PRESENCE_SUFFIX
- See Also:
-
UNMARSHAL_ATTR_SUFFIX
- See Also:
-
MARSHAL_ATTR_SUFFIX
- See Also:
-
PRESENCE_SUFFIX
- See Also:
-
UNMARSHAL_SUFFIX
- See Also:
-
MARSHAL_SUFFIX
- See Also:
-
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
- See Also:
-
SETSOURCE_METHODNAME
- See Also:
-
SETSOURCE_ARGS
private static final Type[] SETSOURCE_ARGS -
SOURCEDOCUMENT_FIELDNAME
- See Also:
-
SOURCELINE_FIELDNAME
- See Also:
-
SOURCECOLUMN_FIELDNAME
- See Also:
-
SOURCENAME_METHODNAME
- See Also:
-
SOURCELINE_METHODNAME
- See Also:
-
SOURCECOLUMN_METHODNAME
- See Also:
-
EMPTY_ARGS
private static final Type[] EMPTY_ARGS -
m_container
Containing binding definition structure. -
m_class
Class linked to mapping. -
m_factoryMethod
Object factory method. -
m_preSetMethod
Preset method for object. -
m_postSetMethod
Postset method for object. -
m_preGetMethod
Preget method for object. -
m_createClass
Type to be used for creating new instances. -
m_createName
Create method fully-qualified name (null
if not yet generated). -
m_checkedComplete
private boolean m_checkedCompleteChecked for complete method needed flag. -
m_checkedPrepare
private boolean m_checkedPrepareChecked for prepare method needed flag. -
m_completeName
Complete method name (null
if none, or not yet checked). -
m_prepareName
Prepare method name (null
if none, or not yet checked). -
m_newInstanceMethod
Generated new instance method. -
m_lockAttributePresence
private boolean m_lockAttributePresenceFlag for recursion while generating attribute presence test. -
m_lockContentPresence
private boolean m_lockContentPresenceFlag for recursion while generating content presence test. -
m_lockAttributeUnmarshal
private boolean m_lockAttributeUnmarshalFlag for recursion while generating attribute unmarshal. -
m_lockAttributeMarshal
private boolean m_lockAttributeMarshalFlag for recursion while generating attribute marshal. -
m_lockContentUnmarshal
private boolean m_lockContentUnmarshalFlag for recursion while generating attribute unmarshal. -
m_lockContentMarshal
private boolean m_lockContentMarshalFlag for recursion while generating attribute marshal. -
m_attributePresenceName
Name for attribute presence test method (null
unless generation started). -
m_contentPresenceName
Name for content presence test method (null
unless generation started). -
m_unmarshalSignature
Signature used for unmarshal methods. -
m_unmarshalAttributeName
Name for unmarshal attribute method (null
unless generation started). -
m_unmarshalContentName
Name for unmarshal content method (null
unless generation started). -
m_marshalSignature
Signature used for marshal methods. -
m_marshalAttributeName
Name for marshal attribute method (null
unless generation started). -
m_marshalContentName
Name for marshal content method (null
unless generation started). -
m_attributePresenceMethod
Generated attribute presence test method. -
m_contentPresenceMethod
Generated content presence test method. -
m_unmarshalAttributeMethod
Generated unmarshal attribute method. -
m_unmarshalContentMethod
Generated unmarshal content method. -
m_marshalAttributeMethod
Generated marshal attribute method. -
m_marshalContentMethod
Generated marshal content method. -
m_idChild
Child supplying instance identifier value. -
m_fakeContent
private boolean m_fakeContentFake content present flag, used when neither content nor attributes are present. -
m_mappingWrapper
private boolean m_mappingWrapperFlag for dummy object binding, used when a concrete mapping just adds a name around an abstract mapping.
-
-
Constructor Details
-
ObjectBinding
public ObjectBinding(IContainer contain, IContextObj objc, String type, String fact, String pres, String posts, String pget, 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 Details
-
genUserMethodCall
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
Generate create method for object. The generated method matches theITypeBinding.getCreateMethod()
result signature.- Throws:
JiBXException
- if error in generating code
-
genPrepareMethod
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
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
Generate attribute presence test method for object. The generated method matches theITypeBinding.getAttributePresentTestMethod()
result signature.- Throws:
JiBXException
- if error in configuration
-
genUnmarshalAttributeMethod
Generate attribute unmarshal method for object. The generated method matches theITypeBinding.getAttributeUnmarshalMethod()
result signature.- Throws:
JiBXException
- if error in configuration
-
genMarshalAttributeMethod
Generate attribute marshal method for object. The generated method matches theITypeBinding.getAttributeMarshalMethod()
result signature.- Throws:
JiBXException
- if error in configuration
-
genContentPresenceMethod
Generate content presence test method for object. The generated method matches theITypeBinding.getContentPresentTestMethod()
result signature.- Throws:
JiBXException
- if error in configuration
-
genUnmarshalContentMethod
Generate content unmarshal method for object. The generated method matches theITypeBinding.getContentUnmarshalMethod()
result signature.- Throws:
JiBXException
-
genMarshalContentMethod
Generate content marshal method for object. The generated method matches theITypeBinding.getContentMarshalMethod()
result signature.- Throws:
JiBXException
-
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
-