Package org.jibx.binding.def
Class DirectObject
java.lang.Object
org.jibx.binding.def.DirectObject
- All Implemented Interfaces:
IComponent
,ILinkable
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
FieldsModifier and TypeFieldDescriptionprivate static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private final DefinitionContext
Definition context for resolving names.private final String
Binding factory name used for activating namespace translation on marshalling (null
if translation not required).private final boolean
Mapping name supplied flag.private final boolean
Abstract mapping flag.private String
Name used for the mapping in binding tables.private ClassFile
Marshaller class (lazy create on first use if name supplied).private final ClassFile
Marshaller base class.private final NameDefinition
Element name information (null
if no bound element).private final IContainer
Containing binding definition structure.private final ClassFile
Class handled by this binding.private ClassFile
Unmarshaller class (lazy create on first use if name supplied).private final ClassFile
Unmarshaller base class.private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
private static final String
-
Constructor Summary
ConstructorsConstructorDescriptionDirectObject
(IContainer parent, DefinitionContext defc, ClassFile target, boolean abs, ClassFile mcf, ClassFile ucf, String mapname, NameDefinition name, String factname) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
createSubclass
(boolean out) Create aliased subclass for marshaller or unmarshaller with element name defined by binding.void
Generate attribute marshalling code.void
Generate attribute unmarshalling code.void
Generate code to test for attribute present.void
Generate element or text marshalling code.void
Generate code to test for content present.void
Generate element or text unmarshalling code.void
Generate code to load ID value of instance to stack.private void
Load name used to identify mapping in binding tables.void
Generate marshalling code for this mapping.void
Generate code to create new instance of object.void
Generate presence test code for this mapping.void
Generate unmarshalling code for this mapping.Get marshaller class used for mapping.Get target class for mapping.getType()
Get type expected by component.Get unmarshaller class used for mapping.Get element wrapper name.boolean
Check if component defines one or more attribute values of the containing element.boolean
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
Check if component is an optional item.void
print
(int depth) void
Establish and validate linkages between binding components.
-
Field Details
-
GETUNMARSHALLER_METHOD
- See Also:
-
GETUNMARSHALLER_SIGNATURE
- See Also:
-
GETMARSHALLER_METHOD
- See Also:
-
GETMARSHALLER_SIGNATURE
- See Also:
-
MARSHALLER_MARSHAL_METHOD
- See Also:
-
MARSHALLER_MARSHAL_SIGNATURE
- See Also:
-
UNMARSHALLER_TESTPRESENT_METHOD
- See Also:
-
UNMARSHALLER_TESTPRESENT_SIGNATURE
- See Also:
-
UNMARSHALLER_UNMARSHAL_METHOD
- See Also:
-
UNMARSHALLER_UNMARSHAL_SIGNATURE
- See Also:
-
ABSTRACTMARSHALLER_INTERFACE
- See Also:
-
ABSTRACTMARSHAL_METHOD
- See Also:
-
ABSTRACTMARSHAL_SIGNATURE
- See Also:
-
ALIASABLE_INTERFACETYPE
- See Also:
-
ANY_INIT_SIG
- See Also:
-
ANY_INITCLASS_SIG
- See Also:
-
MARSHALUNMARSHAL_INIT_SIG
- See Also:
-
MARSHALONLY_INIT_SIG
- See Also:
-
UNMARSHALONLY_INIT_SIG
- See Also:
-
MARSHALUNMARSHAL_INITCLASS_SIG
- See Also:
-
MARSHALONLY_INITCLASS_SIG
- See Also:
-
UNMARSHALONLY_INITCLASS_SIG
- See Also:
-
PUSH_NAMESPACES_METHOD
- See Also:
-
PUSH_NAMESPACES_SIG
- See Also:
-
POP_NAMESPACES_METHOD
- See Also:
-
POP_NAMESPACES_SIG
- See Also:
-
m_parent
Containing binding definition structure. -
m_defContext
Definition context for resolving names. -
m_isAbstract
private final boolean m_isAbstractAbstract 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
Element name information (null
if no bound element). -
m_targetClass
Class handled by this binding. -
m_marshallerBase
Marshaller base class. -
m_unmarshallerBase
Unmarshaller base class. -
m_fixedName
private final boolean m_fixedNameMapping name supplied flag. -
m_factoryName
Binding factory name used for activating namespace translation on marshalling (null
if translation not required). -
m_marshaller
Marshaller class (lazy create on first use if name supplied). -
m_unmarshaller
Unmarshaller class (lazy create on first use if name supplied). -
m_mappingName
Name used for the mapping in binding tables.
-
-
Constructor Details
-
DirectObject
public DirectObject(IContainer parent, DefinitionContext defc, ClassFile target, boolean abs, ClassFile mcf, ClassFile ucf, String mapname, NameDefinition name, String factname) throws JiBXException Constructor.- Parameters:
parent
- containing binding definition structuredefc
- active definitions contexttarget
- class handled by this bindingabs
- abstract mapping flagmcf
- 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 Details
-
genLoadName
Load name used to identify mapping in binding tables.- Parameters:
mb
- method builder- Throws:
JiBXException
-
createSubclass
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
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
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 benull
). The unmarshalled object (ornull
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
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
Get target class for mapping.- Returns:
- target class information
-
getMarshaller
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
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 interfaceIComponent
- 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 interfaceIComponent
- Returns:
true
if one or more attribute values defined for containing element,false
if not
-
genAttrPresentTest
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 interfaceIComponent
- Parameters:
mb
- method builder
-
genAttributeUnmarshal
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 interfaceIComponent
- Parameters:
mb
- method builder
-
genAttributeMarshal
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 interfaceIComponent
- 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 toILinkable.setLinkages()
.- Specified by:
hasContent
in interfaceIComponent
- Returns:
true
if one or more content values defined for containing element,false
if not
-
genContentPresentTest
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 interfaceIComponent
- Parameters:
mb
- method builder- Throws:
JiBXException
- if configuration error
-
genContentUnmarshal
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 interfaceIComponent
- Parameters:
mb
- method builder- Throws:
JiBXException
- if error in configuration
-
genContentMarshal
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 interfaceIComponent
- Parameters:
mb
- method builder- Throws:
JiBXException
- if error in configuration
-
genNewInstance
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 interfaceIComponent
- Parameters:
mb
- method builder
-
getType
Description copied from interface:IComponent
Get type expected by component.- Specified by:
getType
in interfaceIComponent
- 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 interfaceIComponent
- Returns:
true
if ID value defined for instances,false
if not
-
genLoadId
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 aString
).- Specified by:
genLoadId
in interfaceIComponent
- Parameters:
mb
- method builder
-
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 interfaceIComponent
- Returns:
- component element name,
null
if no wrapper element
-
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 interfaceILinkable
- Throws:
JiBXException
- if error in configuration
-
print
public void print(int depth) - Specified by:
print
in interfaceIComponent
-