org.jibx.binding.def
Interface IComponent

All Known Subinterfaces:

IMapping

All Known Implementing Classes:

DirectGeneric, DirectObject, DirectProperty, ElementWrapper, MappingBase, NestedBase, ObjectBinding, PassThroughComponent, ValueChild

public interface IComponent

Child component (attribute or content) interface definition. This interface provides the basic hooks for generating code from the binding definition.

Version:

1.0

Author:

Dennis M. Sosnoski

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.

Method Detail

isOptional

public boolean isOptional()

Check if component is an optional item.

Returns:

true if optional, false if required

hasAttribute

public boolean hasAttribute()

Check if component defines one or more attribute values of the containing element.

Returns:

true if one or more attribute values defined for containing element, false if not

genAttrPresentTest

public void genAttrPresentTest(ContextMethodBuilder mb)
                        throws JiBXException

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.

Parameters:

mb - method builder

Throws:

JiBXException - if configuration error

genAttributeUnmarshal

public void genAttributeUnmarshal(ContextMethodBuilder mb)
                           throws JiBXException

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.

Parameters:

mb - method builder

Throws:

JiBXException - if error in configuration

genAttributeMarshal

public void genAttributeMarshal(ContextMethodBuilder mb)
                         throws JiBXException

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.

Parameters:

mb - method builder

Throws:

JiBXException - if error in configuration

hasContent

public boolean hasContent()

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

Returns:

true if one or more content values defined for containing element, false if not

genContentPresentTest

public void genContentPresentTest(ContextMethodBuilder mb)
                           throws JiBXException

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.

Parameters:

mb - method builder

Throws:

JiBXException - if configuration error

genContentUnmarshal

public void genContentUnmarshal(ContextMethodBuilder mb)
                         throws JiBXException

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.

Parameters:

mb - method builder

Throws:

JiBXException - if error in configuration

genContentMarshal

public void genContentMarshal(ContextMethodBuilder mb)
                       throws JiBXException

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.

Parameters:

mb - method builder

Throws:

JiBXException - if error in configuration

genNewInstance

public void genNewInstance(ContextMethodBuilder mb)
                    throws JiBXException

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.

Parameters:

mb - method builder

Throws:

JiBXException - if error in configuration

getType

public java.lang.String getType()

Get type expected by component.

Returns:

fully qualified class name of expected type

hasId

public boolean hasId()

Check if component defines an ID value for instances of context object.

Returns:

true if ID value defined for instances, false if not

genLoadId

public void genLoadId(ContextMethodBuilder mb)
               throws JiBXException

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

Parameters:

mb - method builder

Throws:

JiBXException - if configuration error

getWrapperName

public NameDefinition getWrapperName()

Get element wrapper name. If the component defines an element as the container for content, this returns the name information for that element.

Returns:

component element name, null if no wrapper element

setLinkages

public void setLinkages()
                 throws JiBXException

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.

Throws:

JiBXException - if error in configuration

print

public void print(int depth)