DirectObject (JiBX Java data binding to XML

java.lang.Object
- org.jibx.binding.def.DirectObject

All Implemented Interfaces:

IComponent, ILinkable
```
public class DirectObject
extends java.lang.Object
implements IComponent
```
Linkage to object with supplied marshaller and unmarshaller. This provides methods used to generate code for calling the supplied classes.

Author:

Dennis M. Sosnoski

Field Summary

Fields
Modifier and Type	Field	Description
`private static java.lang.String`	`ABSTRACTMARSHAL_METHOD`
`private static java.lang.String`	`ABSTRACTMARSHAL_SIGNATURE`
`private static java.lang.String`	`ABSTRACTMARSHALLER_INTERFACE`
`private static java.lang.String`	`ALIASABLE_INTERFACETYPE`
`private static java.lang.String`	`ANY_INIT_SIG`
`private static java.lang.String`	`ANY_INITCLASS_SIG`
`private static java.lang.String`	`GETMARSHALLER_METHOD`
`private static java.lang.String`	`GETMARSHALLER_SIGNATURE`
`private static java.lang.String`	`GETUNMARSHALLER_METHOD`
`private static java.lang.String`	`GETUNMARSHALLER_SIGNATURE`
`private DefinitionContext`	`m_defContext`	Definition context for resolving names.
`private java.lang.String`	`m_factoryName`	Binding factory name used for activating namespace translation on marshalling (`null` if translation not required).
`private boolean`	`m_fixedName`	Mapping name supplied flag.
`private boolean`	`m_isAbstract`	Abstract mapping flag.
`private java.lang.String`	`m_mappingName`	Name used for the mapping in binding tables.
`private ClassFile`	`m_marshaller`	Marshaller class (lazy create on first use if name supplied).
`private ClassFile`	`m_marshallerBase`	Marshaller base class.
`private NameDefinition`	`m_name`	Element name information (`null` if no bound element).
`private IContainer`	`m_parent`	Containing binding definition structure.
`private ClassFile`	`m_targetClass`	Class handled by this binding.
`private ClassFile`	`m_unmarshaller`	Unmarshaller class (lazy create on first use if name supplied).
`private ClassFile`	`m_unmarshallerBase`	Unmarshaller base class.
`private static java.lang.String`	`MARSHALLER_MARSHAL_METHOD`
`private static java.lang.String`	`MARSHALLER_MARSHAL_SIGNATURE`
`private static java.lang.String`	`MARSHALONLY_INIT_SIG`
`private static java.lang.String`	`MARSHALONLY_INITCLASS_SIG`
`private static java.lang.String`	`MARSHALUNMARSHAL_INIT_SIG`
`private static java.lang.String`	`MARSHALUNMARSHAL_INITCLASS_SIG`
`private static java.lang.String`	`POP_NAMESPACES_METHOD`
`private static java.lang.String`	`POP_NAMESPACES_SIG`
`private static java.lang.String`	`PUSH_NAMESPACES_METHOD`
`private static java.lang.String`	`PUSH_NAMESPACES_SIG`
`private static java.lang.String`	`UNMARSHALLER_TESTPRESENT_METHOD`
`private static java.lang.String`	`UNMARSHALLER_TESTPRESENT_SIGNATURE`
`private static java.lang.String`	`UNMARSHALLER_UNMARSHAL_METHOD`
`private static java.lang.String`	`UNMARSHALLER_UNMARSHAL_SIGNATURE`
`private static java.lang.String`	`UNMARSHALONLY_INIT_SIG`
`private static java.lang.String`	`UNMARSHALONLY_INITCLASS_SIG`

Constructor Summary

Constructors
Constructor	Description
`DirectObject(IContainer parent, DefinitionContext defc, ClassFile target, boolean abs, ClassFile mcf, ClassFile ucf, java.lang.String mapname, NameDefinition name, java.lang.String factname)`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private void`	`createSubclass(boolean out)`	Create aliased subclass for marshaller or unmarshaller with element name defined by binding.
`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.
`private void`	`genLoadName(ContextMethodBuilder mb)`	Load name used to identify mapping in binding tables.
`void`	`genMarshal(ContextMethodBuilder mb)`	Generate marshalling code for this mapping.
`void`	`genNewInstance(ContextMethodBuilder mb)`	Generate code to create new instance of object.
`void`	`genTestPresent(ContextMethodBuilder mb)`	Generate presence test code for this mapping.
`void`	`genUnmarshal(ContextMethodBuilder mb)`	Generate unmarshalling code for this mapping.
`ClassFile`	`getMarshaller()`	Get marshaller class used for mapping.
`ClassFile`	`getTargetClass()`	Get target class for mapping.
`java.lang.String`	`getType()`	Get type expected by component.
`ClassFile`	`getUnmarshaller()`	Get unmarshaller class used for mapping.
`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
  - GETUNMARSHALLER_METHOD
```
private static final java.lang.String GETUNMARSHALLER_METHOD
```
    See Also:
    
    Constant Field Values
  - GETUNMARSHALLER_SIGNATURE
```
private static final java.lang.String GETUNMARSHALLER_SIGNATURE
```
    See Also:
    
    Constant Field Values
  - GETMARSHALLER_METHOD
```
private static final java.lang.String GETMARSHALLER_METHOD
```
    See Also:
    
    Constant Field Values
  - GETMARSHALLER_SIGNATURE
```
private static final java.lang.String GETMARSHALLER_SIGNATURE
```
    See Also:
    
    Constant Field Values
  - MARSHALLER_MARSHAL_METHOD
```
private static final java.lang.String MARSHALLER_MARSHAL_METHOD
```
    See Also:
    
    Constant Field Values
  - MARSHALLER_MARSHAL_SIGNATURE
```
private static final java.lang.String MARSHALLER_MARSHAL_SIGNATURE
```
    See Also:
    
    Constant Field Values
  - UNMARSHALLER_TESTPRESENT_METHOD
```
private static final java.lang.String UNMARSHALLER_TESTPRESENT_METHOD
```
    See Also:
    
    Constant Field Values
  - UNMARSHALLER_TESTPRESENT_SIGNATURE
```
private static final java.lang.String UNMARSHALLER_TESTPRESENT_SIGNATURE
```
    See Also:
    
    Constant Field Values
  - UNMARSHALLER_UNMARSHAL_METHOD
```
private static final java.lang.String UNMARSHALLER_UNMARSHAL_METHOD
```
    See Also:
    
    Constant Field Values
  - UNMARSHALLER_UNMARSHAL_SIGNATURE
```
private static final java.lang.String UNMARSHALLER_UNMARSHAL_SIGNATURE
```
    See Also:
    
    Constant Field Values
  - ABSTRACTMARSHALLER_INTERFACE
```
private static final java.lang.String ABSTRACTMARSHALLER_INTERFACE
```
    See Also:
    
    Constant Field Values
  - ABSTRACTMARSHAL_METHOD
```
private static final java.lang.String ABSTRACTMARSHAL_METHOD
```
    See Also:
    
    Constant Field Values
  - ABSTRACTMARSHAL_SIGNATURE
```
private static final java.lang.String ABSTRACTMARSHAL_SIGNATURE
```
    See Also:
    
    Constant Field Values
  - ALIASABLE_INTERFACETYPE
```
private static final java.lang.String ALIASABLE_INTERFACETYPE
```
    See Also:
    
    Constant Field Values
  - ANY_INIT_SIG
```
private static final java.lang.String ANY_INIT_SIG
```
    See Also:
    
    Constant Field Values
  - ANY_INITCLASS_SIG
```
private static final java.lang.String ANY_INITCLASS_SIG
```
    See Also:
    
    Constant Field Values
  - MARSHALUNMARSHAL_INIT_SIG
```
private static final java.lang.String MARSHALUNMARSHAL_INIT_SIG
```
    See Also:
    
    Constant Field Values
  - MARSHALONLY_INIT_SIG
```
private static final java.lang.String MARSHALONLY_INIT_SIG
```
    See Also:
    
    Constant Field Values
  - UNMARSHALONLY_INIT_SIG
```
private static final java.lang.String UNMARSHALONLY_INIT_SIG
```
    See Also:
    
    Constant Field Values
  - MARSHALUNMARSHAL_INITCLASS_SIG
```
private static final java.lang.String MARSHALUNMARSHAL_INITCLASS_SIG
```
    See Also:
    
    Constant Field Values
  - MARSHALONLY_INITCLASS_SIG
```
private static final java.lang.String MARSHALONLY_INITCLASS_SIG
```
    See Also:
    
    Constant Field Values
  - UNMARSHALONLY_INITCLASS_SIG
```
private static final java.lang.String UNMARSHALONLY_INITCLASS_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_parent
```
private final IContainer m_parent
```
    Containing binding definition structure.
  - m_defContext
```
private final DefinitionContext m_defContext
```
    Definition context for resolving names.
  - m_isAbstract
```
private final boolean m_isAbstract
```
    Abstract mapping flag. If this is set the marshalling code will call the special interface method used to verify the type of a passed object and marshal it with the proper handling.
  - m_name
```
private final NameDefinition m_name
```
    Element name information (null if no bound element).
  - m_targetClass
```
private final ClassFile m_targetClass
```
    Class handled by this binding.
  - m_marshallerBase
```
private final ClassFile m_marshallerBase
```
    Marshaller base class.
  - m_unmarshallerBase
```
private final ClassFile m_unmarshallerBase
```
    Unmarshaller base class.
  - m_fixedName
```
private final boolean m_fixedName
```
    Mapping name supplied flag.
  - m_factoryName
```
private final java.lang.String m_factoryName
```
    Binding factory name used for activating namespace translation on marshalling (null if translation not required).
  - m_marshaller
```
private ClassFile m_marshaller
```
    Marshaller class (lazy create on first use if name supplied).
  - m_unmarshaller
```
private ClassFile m_unmarshaller
```
    Unmarshaller class (lazy create on first use if name supplied).
  - m_mappingName
```
private java.lang.String m_mappingName
```
    Name used for the mapping in binding tables.
- Constructor Detail
  - DirectObject
```
public DirectObject(IContainer parent,
                    DefinitionContext defc,
                    ClassFile target,
                    boolean abs,
                    ClassFile mcf,
                    ClassFile ucf,
                    java.lang.String mapname,
                    NameDefinition name,
                    java.lang.String factname)
             throws JiBXException
```
    Constructor.
    
    Parameters:
    
    parent - containing binding definition structure
    
    defc - active definitions context
    
    target - class handled by this binding
    
    abs - abstract mapping flag
    
    mcf - marshaller class information (null if input only binding)
    
    ucf - unmarshaller class information (null if output only binding)
    
    mapname - mapping name in binding definition tables (null if to be constructed)
    
    name - element name information (null if no element name)
    
    factname - binding factory name for marshalling namespace translation (null if no namespace translation)
    
    Throws:
    
    JiBXException - if configuration error
- Method Detail
  - genLoadName
```
private void genLoadName(ContextMethodBuilder mb)
                  throws JiBXException
```
    Load name used to identify mapping in binding tables.
    
    Parameters:
    
    mb - method builder
    
    Throws:
    
    JiBXException
  - createSubclass
```
private void createSubclass(boolean out)
                     throws JiBXException
```
    Create aliased subclass for marshaller or unmarshaller with element name defined by binding. If the same aliasable superclass is defined for use as both a marshaller and an unmarshaller a single subclass is generated to handle both uses.
    
    Parameters:
    
    out - true if alias needed for marshalling, false if for unmarshalling
    
    Throws:
    
    JiBXException - on configuration error
  - genTestPresent
```
public void genTestPresent(ContextMethodBuilder mb)
                    throws JiBXException
```
    Generate presence test code for this mapping. The generated code finds the unmarshaller and calls the test method, leaving the result on the stack.
    
    Parameters:
    
    mb - method builder
    
    Throws:
    
    JiBXException - if error in generating code
  - genUnmarshal
```
public void genUnmarshal(ContextMethodBuilder mb)
                  throws JiBXException
```
    Generate unmarshalling code for this mapping. The generated code finds and calls the unmarshaller with the object to be unmarshaller (which needs to be loaded on the stack by the code prior to this call, but may be null). The unmarshalled object (or null in the case of a missing optional item) is left on the stack after this call. The calling method generally needs to cast this object reference to the appropriate type before using it.
    
    Parameters:
    
    mb - method builder
    
    Throws:
    
    JiBXException - if error in generating code
  - genMarshal
```
public void genMarshal(ContextMethodBuilder mb)
                throws JiBXException
```
    Generate marshalling code for this mapping. The generated code finds and calls the marshaller, passing the object to be marshalled (which should have been loaded to the stack by the prior generated code)..
    
    Parameters:
    
    mb - method builder
    
    Throws:
    
    JiBXException - if error in configuration
  - getTargetClass
```
public ClassFile getTargetClass()
```
    Get target class for mapping.
    
    Returns:
    
    target class information
  - getMarshaller
```
public ClassFile getMarshaller()
                        throws JiBXException
```
    Get marshaller class used for mapping. If a name has been supplied the actual marshaller class is created by extending the base class the first time this method is called.
    
    Returns:
    
    marshaller class information
    
    Throws:
    
    JiBXException - if error in transformation
  - getUnmarshaller
```
public ClassFile getUnmarshaller()
                          throws JiBXException
```
    Get unmarshaller class used for mapping. If a name has been supplied the actual unmarshaller class is created by extending the base class the first time this method is called.
    
    Returns:
    
    unmarshaller class information
    
    Throws:
    
    JiBXException - if error in transformation
  - 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)
```
    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
  - genAttributeUnmarshal
```
public void genAttributeUnmarshal(ContextMethodBuilder mb)
```
    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
  - genAttributeMarshal
```
public void genAttributeMarshal(ContextMethodBuilder mb)
```
    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
  - 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
  - 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)
```
    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
  - 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
  - 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: 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
    
    Throws:
    
    JiBXException - if error in configuration
  - print
```
public void print(int depth)
```
    Specified by:
    
    print in interface IComponent

Class DirectObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GETUNMARSHALLER_METHOD

GETUNMARSHALLER_SIGNATURE

GETMARSHALLER_METHOD

GETMARSHALLER_SIGNATURE

MARSHALLER_MARSHAL_METHOD

MARSHALLER_MARSHAL_SIGNATURE

UNMARSHALLER_TESTPRESENT_METHOD

UNMARSHALLER_TESTPRESENT_SIGNATURE

UNMARSHALLER_UNMARSHAL_METHOD

UNMARSHALLER_UNMARSHAL_SIGNATURE

ABSTRACTMARSHALLER_INTERFACE

ABSTRACTMARSHAL_METHOD

ABSTRACTMARSHAL_SIGNATURE

ALIASABLE_INTERFACETYPE

ANY_INIT_SIG

ANY_INITCLASS_SIG

MARSHALUNMARSHAL_INIT_SIG

MARSHALONLY_INIT_SIG

UNMARSHALONLY_INIT_SIG

MARSHALUNMARSHAL_INITCLASS_SIG

MARSHALONLY_INITCLASS_SIG

UNMARSHALONLY_INITCLASS_SIG

PUSH_NAMESPACES_METHOD

PUSH_NAMESPACES_SIG

POP_NAMESPACES_METHOD

POP_NAMESPACES_SIG

m_parent

m_defContext

m_isAbstract

m_name

m_targetClass

m_marshallerBase

m_unmarshallerBase

m_fixedName

m_factoryName

m_marshaller

m_unmarshaller

m_mappingName

Constructor Detail

DirectObject

Method Detail

genLoadName

createSubclass

genTestPresent

genUnmarshal

genMarshal

getTargetClass

getMarshaller

getUnmarshaller

isOptional

hasAttribute

genAttrPresentTest

genAttributeUnmarshal

genAttributeMarshal

hasContent

genContentPresentTest

genContentUnmarshal

genContentMarshal

genNewInstance

getType

hasId

genLoadId

getWrapperName

setLinkages

print