Package org.jibx.binding.def
Class ValueChild
java.lang.Object
org.jibx.binding.def.ValueChild
- All Implemented Interfaces:
IComponent
,ILinkable
Attribute or simple content value definition from binding. This organizes
information for anything that can be converted to and from a simple
String
. Content values include both elements with only character
data content and text, as character data content or CDATA sections.- Author:
- Dennis M. Sosnoski
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) static final int
(package private) static final int
private static final String[]
private static final Type[]
private static final String
private static final String
Prefix used for backfill classes.private static final String
(package private) static final int
private static final String
private static final String
private static final String
(package private) static final int
private static final String
private static final String
(package private) static final int
(package private) static final int
private final String
Constant value.private final IContainer
Containing binding definition structure.private final StringConversion
Conversion handling for value.private final int
Ident type code.private IMapping
Mapping definition for object class supplying identifier.private final boolean
Nillable element flag.private final NameDefinition
Attribute or element name information.private final IContextObj
Containing object context.private final PropertyDefinition
Linked property information.private final String
Fully qualified name of type.private final int
Value style code.protected static final String
private static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
protected static final String
private static final String
private static final String
(package private) static final int
private static final String
private static final String
(package private) static final int
protected static final String
protected 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
protected static final String
protected 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
ConstructorsConstructorDescriptionValueChild
(IContainer contain, IContextObj objc, NameDefinition name, PropertyDefinition prop, StringConversion conv, int style, int ident, String constant, boolean nillable) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionprivate ClassFile
Create backfill handler class if it does not already exist.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 test if present code.void
Generate code to load ID value of instance to stack.private void
Generate marshalling code.void
Generate code to create new instance of object.private void
Generate unmarshalling code for object identifier reference.private void
Generate unmarshalling code.Get property name.getType()
Get type expected by component.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 implicit.boolean
Check if component is an optional item.void
print
(int depth) void
Establish and validate linkages between binding components.void
Switch property from "this" to "implicit".
-
Field Details
-
DIRECT_IDENT
static final int DIRECT_IDENT- See Also:
-
AUTO_IDENT
static final int AUTO_IDENT- See Also:
-
DEF_IDENT
static final int DEF_IDENT- See Also:
-
REF_IDENT
static final int REF_IDENT- See Also:
-
ATTRIBUTE_STYLE
static final int ATTRIBUTE_STYLE- See Also:
-
ELEMENT_STYLE
static final int ELEMENT_STYLE- See Also:
-
TEXT_STYLE
static final int TEXT_STYLE- See Also:
-
CDATA_STYLE
static final int CDATA_STYLE- See Also:
-
BACKFILL_SUFFIX
Prefix used for backfill classes.- See Also:
-
BACKFILL_INTERFACES
-
BACKFILL_METHODNAME
- See Also:
-
BACKFILL_METHODARGS
private static final Type[] BACKFILL_METHODARGS -
BOUNDREF_NAME
- See Also:
-
CHECK_ELEMENT_NAME
- See Also:
-
CHECK_ATTRIBUTE_NAME
- See Also:
-
CHECK_SIGNATURE
- See Also:
-
UNMARSHAL_DEFREF_ATTR_NAME
- See Also:
-
UNMARSHAL_DEFREF_ELEM_NAME
- See Also:
-
UNMARSHAL_FWDREF_ATTR_NAME
- See Also:
-
UNMARSHAL_FWDREF_ELEM_NAME
- See Also:
-
UNMARSHAL_DEFREF_SIGNATURE
- See Also:
-
REGISTER_BACKFILL_NAME
- See Also:
-
REGISTER_BACKFILL_SIGNATURE
- See Also:
-
DEFINE_ID_NAME
- See Also:
-
DEFINE_ID_SIGNATURE
- See Also:
-
UNMARSHAL_REQ_ATTRIBUTE
- See Also:
-
UNMARSHAL_REQ_SIGNATURE
- See Also:
-
UNMARSHAL_TEXT_NAME
- See Also:
-
UNMARSHAL_TEXT_SIGNATURE
- See Also:
-
UNMARSHAL_ELEMENT_TEXT_NAME
- See Also:
-
UNMARSHAL_ELEMENT_TEXT_SIGNATURE
- See Also:
-
UNMARSHAL_PARSE_IF_START_NAME
- See Also:
-
UNMARSHAL_PARSE_IF_START_SIGNATURE
- See Also:
-
UNMARSHAL_PARSE_TO_START_NAME
- See Also:
-
UNMARSHAL_PARSE_TO_START_SIGNATURE
- See Also:
-
UNMARSHAL_PARSE_PAST_END_NAME
- See Also:
-
UNMARSHAL_PARSE_PAST_END_SIGNATURE
- See Also:
-
UNMARSHAL_SKIPELEMENTMETHOD
- See Also:
-
UNMARSHAL_SKIPELEMENTSIGNATURE
- See Also:
-
MARSHAL_TEXT_NAME
- See Also:
-
MARSHAL_CDATA_NAME
- See Also:
-
MARSHAL_TEXT_SIGNATURE
- See Also:
-
UNMARSHALLING_THROWEXCEPTION_METHOD
- See Also:
-
UNMARSHALLING_THROWEXCEPTION_SIGNATURE
- See Also:
-
MARSHAL_ATTRIBUTE
- See Also:
-
MARSHAL_ELEMENT
- See Also:
-
MARSHAL_SIGNATURE
- See Also:
-
MARSHAL_STARTTAG_ATTRIBUTES
- See Also:
-
MARSHAL_STARTTAG_SIGNATURE
- See Also:
-
MARSHAL_CLOSESTART_EMPTY
- See Also:
-
MARSHAL_CLOSESTART_EMPTY_SIGNATURE
- See Also:
-
UNMARSHAL_ATTRIBUTE_BOOLEAN_NAME
- See Also:
-
UNMARSHAL_ATTRIBUTE_BOOLEAN_SIGNATURE
- See Also:
-
m_container
Containing binding definition structure. -
m_objContext
Containing object context. -
m_valueStyle
private final int m_valueStyleValue style code. -
m_constantValue
Constant value. -
m_identType
private final int m_identTypeIdent type code. -
m_name
Attribute or element name information. -
m_type
Fully qualified name of type. -
m_isNillable
private final boolean m_isNillableNillable element flag. -
m_property
Linked property information. -
m_conversion
Conversion handling for value. -
m_idRefMap
Mapping definition for object class supplying identifier.
-
-
Constructor Details
-
ValueChild
public ValueChild(IContainer contain, IContextObj objc, NameDefinition name, PropertyDefinition prop, StringConversion conv, int style, int ident, String constant, boolean nillable) Constructor. Saves the context information for later use.- Parameters:
contain
- containing binding definition structureobjc
- containing object contextname
- element or attribute name information (may benull
)prop
- property reference informationconv
- string conversion handlerstyle
- value style codeident
- identifier type codeconstant
- value for constantnillable
- nillable element flag
-
-
Method Details
-
createBackfillClass
Create backfill handler class if it does not already exist. This either looks up the existing backfill handler class or creates a new one specifically for this value.- Returns:
- backfill handler class for value
- Throws:
JiBXException
- if error in configuration
-
genParseIdRef
Generate unmarshalling code for object identifier reference. The code generated by this method assumes the unmarshalling context and name have already been loaded to the stack, and these are consumed by the code.- Parameters:
mb
- method builder- Throws:
JiBXException
- if error in configuration
-
genIfPresentTest
Generate test if present code. This generates code that tests if the child is present, leaving the result of the test (zero if missing, nonzero if present) on the stack.- Parameters:
mb
- unmarshal method builder- Throws:
JiBXException
- if configuration error
-
genUnmarshal
Generate unmarshalling code. This internal method generates the necessary code for handling the unmarshalling operation. The code generated by this method restores the stack to the original state when done.- Parameters:
mb
- method builder- Throws:
JiBXException
- if error in configuration
-
genMarshal
Generate marshalling code. This internal method generates the necessary code for handling the marshalling operation. The code generated by this method restores the stack to the original state when done.- Parameters:
mb
- method builder- Throws:
JiBXException
- if error in configuration
-
getPropertyName
Get property name. If the child has an associated property this returns the name of that property.- Returns:
- name for child property
-
isImplicit
public boolean isImplicit()Check if implicit.- Returns:
true
if implicit,false
if not
-
switchProperty
public void switchProperty()Switch property from "this" to "implicit". -
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- Throws:
JiBXException
- if configuration error
-
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- Throws:
JiBXException
- if error in configuration
-
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- Throws:
JiBXException
- if error in configuration
-
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:
mub
- method builder- Throws:
JiBXException
- if configuration error
-
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
-