org.jibx.binding.def
Class PrecompiledBinding

java.lang.Object
  extended by org.jibx.binding.def.PrecompiledBinding
All Implemented Interfaces:
IComponent, ILinkable, ITypeBinding

public class PrecompiledBinding
extends java.lang.Object
implements IComponent, 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
private  java.lang.String m_attributePresenceName
          Name for attribute presence test method (null if none).
private  ClassFile m_class
          Class handled by binding.
private  java.lang.String m_completeName
          Complete method name (null if none).
private  java.lang.String m_completeSignature
          Signature used for complete method.
private  java.lang.String m_contentPresenceName
          Name for content presence test method (null if none).
private  java.lang.String m_factoryName
          Binding factory name used for activating namespace translation on marshalling (null if translation not required).
private  java.lang.String m_marshalAttributeName
          Name for marshal attribute method (null if none).
private  java.lang.String m_marshalContentName
          Name for marshal content method (null if none).
private  java.lang.String m_marshalSignature
          Signature used for marshalling (and prepare) methods.
private  java.lang.String m_newInstanceName
          New instance method name.
private  java.lang.String m_prepareName
          Prepare method name (null if none).
private  java.lang.String m_unmarshalAttributeName
          Name for unmarshal attribute method (null if none).
private  java.lang.String m_unmarshalContentName
          Name for unmarshal content method (null if none).
private  java.lang.String m_unmarshalSignature
          Signature used for unmarshalling (and new instance) methods.
private static java.lang.String MARSHALLING_CONTEXT
           
private static java.lang.String MARSHALLING_CONTEXT_SIG
           
private static java.lang.String POP_NAMESPACES_METHOD
           
private static java.lang.String POP_NAMESPACES_SIG
           
private static java.lang.String PRESENCE_TEST_SIG
           
private static java.lang.String PUSH_NAMESPACES_METHOD
           
private static java.lang.String PUSH_NAMESPACES_SIG
           
private static java.lang.String UNMARSHALLING_CONTEXT
           
private static java.lang.String UNMARSHALLING_CONTEXT_SIG
           
 
Constructor Summary
PrecompiledBinding(int index, java.lang.String[][] abmaps, boolean xlated, java.lang.String factname)
          Constructor.
 
Method Summary
 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.
 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.
 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.
 NameDefinition getWrapperName()
          Get element wrapper name.
 boolean hasAttribute()
          Check if component defines one or more attribute values of the containing element.
 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)
           
 void setLinkages()
          Establish and validate linkages between binding components.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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

MARSHALLING_CONTEXT_SIG

private static final java.lang.String MARSHALLING_CONTEXT_SIG
See Also:
Constant Field Values

UNMARSHALLING_CONTEXT_SIG

private static final java.lang.String UNMARSHALLING_CONTEXT_SIG
See Also:
Constant Field Values

PRESENCE_TEST_SIG

private static final java.lang.String PRESENCE_TEST_SIG
See Also:
Constant Field Values

PUSH_NAMESPACES_METHOD

private static final java.lang.String PUSH_NAMESPACES_METHOD
See Also:
Constant Field Values

PUSH_NAMESPACES_SIG

private static final java.lang.String PUSH_NAMESPACES_SIG
See Also:
Constant Field Values

POP_NAMESPACES_METHOD

private static final java.lang.String POP_NAMESPACES_METHOD
See Also:
Constant Field Values

POP_NAMESPACES_SIG

private static final java.lang.String POP_NAMESPACES_SIG
See Also:
Constant Field Values

m_class

private final ClassFile m_class
Class handled by binding.


m_newInstanceName

private final java.lang.String m_newInstanceName
New instance method name.


m_completeName

private final java.lang.String m_completeName
Complete method name (null if none).


m_prepareName

private final java.lang.String m_prepareName
Prepare method name (null if none).


m_attributePresenceName

private final java.lang.String m_attributePresenceName
Name for attribute presence test method (null if none).


m_contentPresenceName

private final java.lang.String m_contentPresenceName
Name for content presence test method (null if none).


m_unmarshalAttributeName

private final java.lang.String m_unmarshalAttributeName
Name for unmarshal attribute method (null if none).


m_unmarshalContentName

private final java.lang.String m_unmarshalContentName
Name for unmarshal content method (null if none).


m_marshalAttributeName

private final java.lang.String m_marshalAttributeName
Name for marshal attribute method (null if none).


m_marshalContentName

private final java.lang.String m_marshalContentName
Name for marshal content method (null if none).


m_unmarshalSignature

private final java.lang.String m_unmarshalSignature
Signature used for unmarshalling (and new instance) methods.


m_completeSignature

private final java.lang.String m_completeSignature
Signature used for complete method.


m_marshalSignature

private final java.lang.String m_marshalSignature
Signature used for marshalling (and prepare) methods.


m_factoryName

private final java.lang.String m_factoryName
Binding factory name used for activating namespace translation on marshalling (null if translation not required).

Constructor Detail

PrecompiledBinding

public PrecompiledBinding(int index,
                          java.lang.String[][] abmaps,
                          boolean xlated,
                          java.lang.String factname)
                   throws JiBXException
Constructor.

Parameters:
index - abstract mapping index in binding
abmaps - abstract mapping information from binding
xlated - translated namespaces for binding flag
factname - binding factory name
Throws:
JiBXException - on error loading class information
Method Detail

isOptional

public boolean isOptional()
Description copied from interface: IComponent
Check if component is an optional item.

Specified by:
isOptional in interface IComponent
Returns:
true if optional, false if required

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 interface IComponent
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 interface IComponent
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 interface IComponent
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 interface IComponent
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 interface IComponent
Parameters:
mb - method builder
Throws:
JiBXException - if error in configuration

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 interface IComponent
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 interface IComponent
Parameters:
mb - method builder
Throws:
JiBXException - if configuration error

getType

public java.lang.String getType()
Description copied from interface: IComponent
Get type expected by component.

Specified by:
getType in interface IComponent
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 interface IComponent
Returns:
true if ID value defined for instances, false if not

genLoadId

public void genLoadId(ContextMethodBuilder mb)
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 a String).

Specified by:
genLoadId in interface IComponent
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 interface ILinkable

getWrapperName

public NameDefinition 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 interface IComponent
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 interface IComponent
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 to ILinkable.setLinkages().

Specified by:
hasContent in interface IComponent
Returns:
true if one or more content values defined for containing element, false if not

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 interface ITypeBinding
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 returns true if an attribute of the mapping is found, false if not.

Specified by:
getAttributePresentTestMethod in interface ITypeBinding
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 interface ITypeBinding
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 interface ITypeBinding
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 interface ITypeBinding
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 returns true if an attribute of the mapping is found, false if not.

Specified by:
getContentPresentTestMethod in interface ITypeBinding
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 interface ITypeBinding
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 interface ITypeBinding
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 interface ITypeBinding
Returns:
prepare method, or null if none
Throws:
JiBXException - on error in code generation

print

public void print(int depth)
Specified by:
print in interface IComponent


Project Web Site