org.jibx.binding.def
Class PassThroughComponent

java.lang.Object
  extended byorg.jibx.binding.def.PassThroughComponent
All Implemented Interfaces:
IComponent
Direct Known Subclasses:
BaseMappingWrapper, ComponentProperty, LinkableBase, MappingReference, ObjectBinding, OptionalStructureWrapper, StructureReference

public class PassThroughComponent
extends java.lang.Object
implements IComponent

Default component decorator. This just passes through all method calls to the wrapped component.

Version:
1.0
Author:
Dennis M. Sosnoski

Field Summary
protected  IComponent m_component
          Property value binding component.
 
Constructor Summary
protected PassThroughComponent()
          No argument constructor.
protected PassThroughComponent(IComponent comp)
          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 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.
protected  void setWrappedComponent(IComponent comp)
          Set the wrapped component.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_component

protected IComponent m_component
Property value binding component.

Constructor Detail

PassThroughComponent

protected PassThroughComponent()
No argument constructor. This requires the component to be set later, using the setWrappedComponent(org.jibx.binding.def.IComponent) method.


PassThroughComponent

protected PassThroughComponent(IComponent comp)
Constructor.

Parameters:
comp - wrapped component
Method Detail

setWrappedComponent

protected void setWrappedComponent(IComponent comp)
Set the wrapped component.

Parameters:
comp - wrapped component

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

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

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

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

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 IComponent.setLinkages().

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

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

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

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)
               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 a String).

Specified by:
genLoadId in interface IComponent
Parameters:
mb - method builder
Throws:
JiBXException - if configuration error

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

setLinkages

public void setLinkages()
                 throws JiBXException
Description copied from interface: IComponent
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 IComponent
Throws:
JiBXException - if error in configuration

print

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


Project Web Site