Package org.jibx.binding.def
Class DirectGeneric
- java.lang.Object
-
- org.jibx.binding.def.DirectGeneric
-
- All Implemented Interfaces:
IComponent
,ILinkable
public class DirectGeneric extends java.lang.Object implements IComponent
Linkage to generic object with defined marshaller and/or unmarshaller. This provides methods used to generate code for marshalling and unmarshalling objects of types unknown at binding time, so long as they have mappings defined.- Version:
- 1.0
- Author:
- Dennis M. Sosnoski
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
ISEND_METHOD
private static java.lang.String
ISEND_SIGNATURE
private PropertyDefinition
m_property
Optional property definition.private java.lang.String
m_type
Type handled by this binding.private static java.lang.String
MARSHALLABLE_INTERFACE
private static java.lang.String
MARSHALLABLE_METHOD
private static java.lang.String
MARSHALLABLE_SIGNATURE
private static java.lang.String
UNMARSHALELEMENT_METHOD
private static java.lang.String
UNMARSHALELEMENT_SIGNATURE
-
Constructor Summary
Constructors Constructor Description DirectGeneric(IContainer parent, java.lang.String type)
Constructor without implicit property.DirectGeneric(IContainer parent, java.lang.String type, PropertyDefinition prop)
Constructor with defined property.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
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.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.
-
-
-
Field Detail
-
ISEND_METHOD
private static final java.lang.String ISEND_METHOD
- See Also:
- Constant Field Values
-
ISEND_SIGNATURE
private static final java.lang.String ISEND_SIGNATURE
- See Also:
- Constant Field Values
-
UNMARSHALELEMENT_METHOD
private static final java.lang.String UNMARSHALELEMENT_METHOD
- See Also:
- Constant Field Values
-
UNMARSHALELEMENT_SIGNATURE
private static final java.lang.String UNMARSHALELEMENT_SIGNATURE
- See Also:
- Constant Field Values
-
MARSHALLABLE_INTERFACE
private static final java.lang.String MARSHALLABLE_INTERFACE
- See Also:
- Constant Field Values
-
MARSHALLABLE_METHOD
private static final java.lang.String MARSHALLABLE_METHOD
- See Also:
- Constant Field Values
-
MARSHALLABLE_SIGNATURE
private static final java.lang.String MARSHALLABLE_SIGNATURE
- See Also:
- Constant Field Values
-
m_type
private final java.lang.String m_type
Type handled by this binding.
-
m_property
private final PropertyDefinition m_property
Optional property definition.
-
-
Constructor Detail
-
DirectGeneric
public DirectGeneric(IContainer parent, java.lang.String type)
Constructor without implicit property.- Parameters:
parent
- containing binding definition structuretype
- fully qualified class name of object type handled by this binding (null
if unspecified)
-
DirectGeneric
public DirectGeneric(IContainer parent, java.lang.String type, PropertyDefinition prop)
Constructor with defined property.- Parameters:
parent
- containing binding definition structuretype
- fully qualified class name of object type handled by this binding (null
if unspecified)prop
- associated property information
-
-
Method Detail
-
genTestPresent
public void genTestPresent(ContextMethodBuilder mb)
Generate presence test code for this mapping. The generated code just checks that a start tag is next in the document, rather than an end tag.- Parameters:
mb
- method builder
-
genUnmarshal
public void genUnmarshal(ContextMethodBuilder mb) throws JiBXException
Generate unmarshalling code for this mapping. The generated code just calls the generic unmarshal element method, leaving the unmarshalled object on the stack (after casting it, if necessary, to the appropriate type). TODO: Instead call unmarshalling method with class passed directly, for better error reporting.- Parameters:
mb
- method builder- Throws:
JiBXException
-
genMarshal
public void genMarshal(ContextMethodBuilder mb) throws JiBXException
Generate marshalling code for this mapping. The generated code loads the object reference and casts it to the generic marshal interface, then calls the marshal method of that interface.- Parameters:
mb
- method builder- Throws:
JiBXException
-
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
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 interfaceIComponent
- 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 interfaceIComponent
- 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 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
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 interfaceIComponent
- 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 interfaceIComponent
- 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 interfaceIComponent
- 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 interfaceIComponent
- Parameters:
mb
- method builder
-
getType
public java.lang.String 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
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 aString
).- Specified by:
genLoadId
in interfaceIComponent
- 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 interfaceIComponent
- Returns:
- component element name,
null
if no wrapper element
-
setLinkages
public void 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
-
print
public void print(int depth)
- Specified by:
print
in interfaceIComponent
-
-