Package org.jibx.binding.def
Class PrecompiledBinding
java.lang.Object
org.jibx.binding.def.PrecompiledBinding
- All Implemented Interfaces:
IComponent
,ILinkable
,ITypeBinding
Linkage to object marshalling/unmarshalling code for a class handled by an
abstract mapping in a precompiled binding. This is constructed from the
information in the binding factory, then used in the actual code generation
processing to call the methods when referenced.
- Author:
- Dennis M. Sosnoski
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final String
Name for attribute presence test method (null
if none).private final ClassFile
Class handled by binding.private final String
Complete method name (null
if none).private final String
Signature used for complete method.private final String
Name for content presence test method (null
if none).private final String
Binding factory name used for activating namespace translation on marshalling (null
if translation not required).private final String
Name for marshal attribute method (null
if none).private final String
Name for marshal content method (null
if none).private final String
Signature used for marshalling (and prepare) methods.private final String
New instance method name.private final String
Prepare method name (null
if none).private final String
Name for unmarshal attribute method (null
if none).private final String
Name for unmarshal content method (null
if none).private final String
Signature used for unmarshalling (and new instance) 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 String
private static final String
-
Constructor Summary
ConstructorsConstructorDescriptionPrecompiledBinding
(int index, String[][] abmaps, boolean xlated, String factname) 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.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 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.Get element wrapper name.boolean
Check if component defines one or more attribute values of the containing element.boolean
Check if component defines one or more elements or text values as children of the containing element.boolean
hasId()
Check if component defines an ID value for instances of context object.boolean
Check if component is an optional item.void
print
(int depth) void
Establish and validate linkages between binding components.
-
Field Details
-
MARSHALLING_CONTEXT
- See Also:
-
UNMARSHALLING_CONTEXT
- See Also:
-
MARSHALLING_CONTEXT_SIG
- See Also:
-
UNMARSHALLING_CONTEXT_SIG
- See Also:
-
PRESENCE_TEST_SIG
- See Also:
-
PUSH_NAMESPACES_METHOD
- See Also:
-
PUSH_NAMESPACES_SIG
- See Also:
-
POP_NAMESPACES_METHOD
- See Also:
-
POP_NAMESPACES_SIG
- See Also:
-
m_class
Class handled by binding. -
m_newInstanceName
New instance method name. -
m_completeName
Complete method name (null
if none). -
m_prepareName
Prepare method name (null
if none). -
m_attributePresenceName
Name for attribute presence test method (null
if none). -
m_contentPresenceName
Name for content presence test method (null
if none). -
m_unmarshalAttributeName
Name for unmarshal attribute method (null
if none). -
m_unmarshalContentName
Name for unmarshal content method (null
if none). -
m_marshalAttributeName
Name for marshal attribute method (null
if none). -
m_marshalContentName
Name for marshal content method (null
if none). -
m_unmarshalSignature
Signature used for unmarshalling (and new instance) methods. -
m_completeSignature
Signature used for complete method. -
m_marshalSignature
Signature used for marshalling (and prepare) methods. -
m_factoryName
Binding factory name used for activating namespace translation on marshalling (null
if translation not required).
-
-
Constructor Details
-
PrecompiledBinding
public PrecompiledBinding(int index, String[][] abmaps, boolean xlated, String factname) throws JiBXException Constructor.- Parameters:
index
- abstract mapping index in bindingabmaps
- abstract mapping information from bindingxlated
- translated namespaces for binding flagfactname
- binding factory name- Throws:
JiBXException
- on error loading class information
-
-
Method Details
-
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
-
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- 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
- 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
- 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
-
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- 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
- Parameters:
mb
- method builder- Throws:
JiBXException
- if configuration error
-
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
-
setLinkages
public void 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
-
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
-
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
-
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
-
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
-