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 inherited from class org.jibx.binding.def.PassThroughComponent
m_component
-
-
Constructor Summary
Constructors Constructor Description ObjectBinding(IContainer contain, IContextObj objc, String type, String fact, String pres, String posts, String pget, String ctype)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
genAttributeMarshal(ContextMethodBuilder mb)
Generate attribute marshalling code.void
genAttributeUnmarshal(ContextMethodBuilder mb)
Generate attribute unmarshalling code.void
genAttrPresentTest(ContextMethodBuilder mb)
Generate code to test for attribute present.void
genContentMarshal(ContextMethodBuilder mb)
Generate element or text marshalling code.void
genContentPresentTest(ContextMethodBuilder mb)
Generate code to test for content present.void
genContentUnmarshal(ContextMethodBuilder mb)
Generate element or text unmarshalling code.void
genLoadId(ContextMethodBuilder mb)
Generate code to load ID value of instance to stack.void
genNewInstance(ContextMethodBuilder mb)
Generate code to create new instance of object.String
getAttributeMarshalMethod()
Get the method which marshals attributes from an instance.String
getAttributePresentTestMethod()
Get the method which checks attributes to determine if an instance is present.String
getAttributeUnmarshalMethod()
Get the method which unmarshals attributes into an instance.BoundClass
getBoundClass()
Get class linked to binding element.String
getCompleteMethod()
Get the method which handles unmarshalling completion.String
getContentMarshalMethod()
Get the method which marshals child elements and character data content from an instance.String
getContentPresentTestMethod()
Get the method which checks child elements to determine if an instance is present.String
getContentUnmarshalMethod()
Get the method which unmarshals child elements and character data content into an instance.String
getCreateMethod()
Get the method which creates an instance of the bound class if one does not already exist.String
getPrepareMethod()
Get the method which handles preparation for marshalling an instance.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
-
-
-
-
Constructor Detail
-
ObjectBinding
public ObjectBinding(IContainer contain, IContextObj objc, String type, String fact, String pres, String posts, String pget, String ctype) throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- if method not found
-
-
Method Detail
-
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 org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- if configuration error
-
genContentPresentTest
public void genContentPresentTest(ContextMethodBuilder mb) throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- if configuration error
-
genAttributeUnmarshal
public void genAttributeUnmarshal(ContextMethodBuilder mb) throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- if error in configuration
-
genAttributeMarshal
public void genAttributeMarshal(ContextMethodBuilder mb) throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- if error in configuration
-
genContentUnmarshal
public void genContentUnmarshal(ContextMethodBuilder mb) throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- if error in configuration
-
genContentMarshal
public void genContentMarshal(ContextMethodBuilder mb) throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- if error in configuration
-
genNewInstance
public void genNewInstance(ContextMethodBuilder mb) throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- if error in configuration
-
getType
public 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 org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- if configuration error
-
setLinkages
public void setLinkages() throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- if error in configuration
-
getAttributeMarshalMethod
public String getAttributeMarshalMethod() throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- on error in code generation
-
getAttributePresentTestMethod
public String getAttributePresentTestMethod() throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- on error in code generation
-
getAttributeUnmarshalMethod
public String getAttributeUnmarshalMethod() throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- on error in code generation
-
getCompleteMethod
public String getCompleteMethod() throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- on error in code generation
-
getContentMarshalMethod
public String getContentMarshalMethod() throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- on error in code generation
-
getContentPresentTestMethod
public String getContentPresentTestMethod() throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- on error in code generation
-
getContentUnmarshalMethod
public String getContentUnmarshalMethod() throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- on error in code generation
-
getCreateMethod
public String getCreateMethod() throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- on error in code generation
-
getPrepareMethod
public String getPrepareMethod() throws org.jibx.runtime.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:
org.jibx.runtime.JiBXException
- on error in code generation
-
print
public void print(int depth)
- Specified by:
print
in interfaceIComponent
- Overrides:
print
in classPassThroughComponent
-
-