| org.jibx.binding.def.IComponent
All known Subclasses: org.jibx.binding.def.DirectObject, org.jibx.binding.def.DirectGeneric, org.jibx.binding.def.ElementWrapper, org.jibx.binding.def.DirectProperty, org.jibx.binding.def.PassThroughComponent, org.jibx.binding.def.ObjectBinding, org.jibx.binding.def.ValueChild, org.jibx.binding.def.NestedBase,
| IComponent | | public interface IComponent (Code) | | Child component (attribute or content) interface definition. This interface
provides the basic hooks for generating code from the binding definition.
author:
Dennis M. Sosnoski
version:
1.0 |
| genAttrPresentTest | | public void genAttrPresentTest(ContextMethodBuilder mb) throws JiBXException(Code) | | 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 |
| genAttributeMarshal | | public void genAttributeMarshal(ContextMethodBuilder mb) throws JiBXException(Code) | | 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 |
| genAttributeUnmarshal | | public void genAttributeUnmarshal(ContextMethodBuilder mb) throws JiBXException(Code) | | 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 |
| genContentMarshal | | public void genContentMarshal(ContextMethodBuilder mb) throws JiBXException(Code) | | 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 |
| genContentPresentTest | | public void genContentPresentTest(ContextMethodBuilder mb) throws JiBXException(Code) | | 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(Code) | | 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 |
| genLoadId | | public void genLoadId(ContextMethodBuilder mb) throws JiBXException(Code) | | 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 |
| genNewInstance | | public void genNewInstance(ContextMethodBuilder mb) throws JiBXException(Code) | | 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 String getType()(Code) | | Get type expected by component.
fully qualified class name of expected type |
| getWrapperName | | public NameDefinition getWrapperName()(Code) | | Get element wrapper name. If the component defines an element as the
container for content, this returns the name information for that
element.
component element name, null if no wrapper element |
| hasAttribute | | public boolean hasAttribute()(Code) | | Check if component defines one or more attribute values of the
containing element.
true if one or more attribute values defined forcontaining element, false if not |
| hasContent | | public boolean hasContent()(Code) | | 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() .
true if one or more content values definedfor containing element, false if not |
| hasId | | public boolean hasId()(Code) | | Check if component defines an ID value for instances of context object.
true if ID value defined for instances,false if not |
| isOptional | | public boolean isOptional()(Code) | | Check if component is an optional item.
true if optional, false if required |
| print | | public void print(int depth)(Code) | | |
| setLinkages | | public void setLinkages() throws JiBXException(Code) | | 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 |
|
|