Package org.jibx.binding.def
Class PrimitiveStringConversion
java.lang.Object
org.jibx.binding.def.StringConversion
org.jibx.binding.def.PrimitiveStringConversion
Primitive string conversion handling. Class for handling serialization
converting a primitive type to and from
String
values.- Author:
- Dennis M. Sosnoski
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
private static final int
private static final int
private static final int
private boolean
Marshalling requires conversion to text flag.private boolean
Unmarshalling requires conversion to text flag.private String
Name of value type on stack.private ClassItem
Unmarshalling context method for optional attribute.private ClassItem
Unmarshalling context method for optional element.private ClassItem
Unmarshalling context method for required attribute.private ClassItem
Unmarshalling context method for required element.private int
Comparison and marshal type of value (INT_TYPE, LONG_TYPE, FLOAT_TYPE, or DOUBLE_TYPE)private static ClassFile
private static final Class[]
Constant argument type array for finding conversion methods.private static final String
Unmarshal method signature leading portion.private static final String
Class providing basic conversion methods.Fields inherited from class org.jibx.binding.def.StringConversion
COMPARE_OBJECTS_METHOD, COMPARE_OBJECTS_SIGNATURE, DESERIALIZER_SIGNATURES, m_converter, m_default, m_deserializer, m_serializer, m_typeName, m_typeSignature, MARSHAL_ATTRIBUTE, MARSHAL_ELEMENT, MARSHAL_NAME_VALUES, MARSHAL_SIGNATURE, UNMARSHAL_OPT_ATTRIBUTE, UNMARSHAL_OPT_ELEMENT, UNMARSHAL_OPT_SIGNATURE, UNMARSHAL_REQ_ATTRIBUTE, UNMARSHAL_REQ_ELEMENT, UNMARSHAL_REQ_SIGNATURE, WHITESPACE_CONVERT_SIGNATURES
-
Constructor Summary
ConstructorsModifierConstructorDescriptionPrimitiveStringConversion
(Class cls, Object dflt, String code, String ts, String fs, String uattr, String uelem) Constructor.protected
PrimitiveStringConversion
(String type, PrimitiveStringConversion inherit) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionprotected Object
convertDefault
(String text) Convert text representation into default value object.Derive from existing formatting information.void
Generate code to convertString
representation.void
genParseOptional
(boolean attr, ContextMethodBuilder mb) Generate code to parse and convert optional attribute or element.void
genParseRequired
(boolean attr, ContextMethodBuilder mb) Generate code to parse and convert required attribute or element.protected BranchWrapper
genToOptionalText
(String type, ContextMethodBuilder mb, int extra) Generate code to check if an optional value is not equal to the default.boolean
Check if the type handled by this conversion is of a primitive type.protected void
Push default value on stack.protected void
setDeserializer
(String deser) Set deserializer for conversion.protected void
setSerializer
(String ser) Set serializer for conversion.protected void
setWhitespaceConverter
(String wsconv) Set whitespace converter for conversion.Methods inherited from class org.jibx.binding.def.StringConversion
genPopValues, genToText, genWriteOptional, genWriteRequired, genWriteText, getTypeName, setSerializer
-
Field Details
-
s_unmarshalClass
-
INT_TYPE
private static final int INT_TYPE- See Also:
-
LONG_TYPE
private static final int LONG_TYPE- See Also:
-
FLOAT_TYPE
private static final int FLOAT_TYPE- See Also:
-
DOUBLE_TYPE
private static final int DOUBLE_TYPE- See Also:
-
UTILITY_CLASS_NAME
Class providing basic conversion methods.- See Also:
-
UNMARSHAL_SIG_LEAD
Unmarshal method signature leading portion.- See Also:
-
SINGLE_STRING_ARGS
Constant argument type array for finding conversion methods. -
m_isMarshalText
private boolean m_isMarshalTextMarshalling requires conversion to text flag. -
m_isUnmarshalText
private boolean m_isUnmarshalTextUnmarshalling requires conversion to text flag. -
m_unmarshalOptAttribute
Unmarshalling context method for optional attribute. -
m_unmarshalOptElement
Unmarshalling context method for optional element. -
m_unmarshalReqAttribute
Unmarshalling context method for required attribute. -
m_unmarshalReqElement
Unmarshalling context method for required element. -
m_valueType
private int m_valueTypeComparison and marshal type of value (INT_TYPE, LONG_TYPE, FLOAT_TYPE, or DOUBLE_TYPE) -
m_stackType
Name of value type on stack.
-
-
Constructor Details
-
PrimitiveStringConversion
Constructor. Initializes conversion handling based on the supplied inherited handling.- Parameters:
type
- name of primitive type handled by conversioninherit
- conversion information inherited by this conversion
-
PrimitiveStringConversion
public PrimitiveStringConversion(Class cls, Object dflt, String code, String ts, String fs, String uattr, String uelem) Constructor. Initializes conversion handling based on argument values. This form is only used for constructing the default set of conversions.- Parameters:
cls
- class of primitive type handled by conversiondflt
- default value object (wrapped value, orString
ornull
with special deserializer)code
- primitive type codets
- name of utility class static method for converting value toString
fs
- name of utility class static method for convertingString
to valueuattr
- unmarshalling context method name for attribute valueuelem
- unmarshalling context method name for element value
-
-
Method Details
-
genFromText
Generate code to convertString
representation. The code generated by this method assumes that theString
value has already been pushed on the stack. It consumes this and leaves the converted value on the stack.- Specified by:
genFromText
in classStringConversion
- Parameters:
mb
- method builder
-
pushDefault
Push default value on stack. Just adds the appropriate instruction to the list for the method.- Parameters:
mb
- method builder
-
genParseOptional
Generate code to parse and convert optional attribute or element. The code generated by this method assumes that the unmarshalling context and name information for the attribute or element have already been pushed on the stack. It consumes these and leaves the converted value (or default value, if the item itself is missing) on the stack.- Specified by:
genParseOptional
in classStringConversion
- Parameters:
attr
- item is an attribute (vs element) flagmb
- method builder- Throws:
JiBXException
- if error in configuration
-
genParseRequired
Generate code to parse and convert required attribute or element. The code generated by this method assumes that the unmarshalling context and name information for the attribute or element have already been pushed on the stack. It consumes these and leaves the converted value on the stack.- Specified by:
genParseRequired
in classStringConversion
- Parameters:
attr
- item is an attribute (vs element) flagmb
- method builder- Throws:
JiBXException
- if error in configuration
-
genToOptionalText
protected BranchWrapper genToOptionalText(String type, ContextMethodBuilder mb, int extra) throws JiBXException Generate code to check if an optional value is not equal to the default. The code generated by this method assumes that the actual value to be converted has already been pushed on the stack. It consumes this, leaving the converted text reference on the stack if it's not equal to the default value.- Specified by:
genToOptionalText
in classStringConversion
- Parameters:
type
- fully qualified class name for value on stackmb
- method builderextra
- count of extra values to be popped from stack if missing- Returns:
- handle for branch taken when value is equal to the default (target must be set by caller)
- Throws:
JiBXException
- if error in configuration
-
convertDefault
Convert text representation into default value object. This override of the base class method uses reflection to call the actual deserialization method, returning the wrapped result value. If a custom deserializer is defined this just returns theString
value directly.- Specified by:
convertDefault
in classStringConversion
- Parameters:
text
- value representation to be converted- Returns:
- converted default value object
- Throws:
JiBXException
- on conversion error
-
isPrimitive
public boolean isPrimitive()Check if the type handled by this conversion is of a primitive type.- Specified by:
isPrimitive
in classStringConversion
- Returns:
true
to indicate primitive type
-
setSerializer
Set serializer for conversion. This override of the base class method sets a flag to indicate that values must be converted to text before they are written to a document after executing the base class processing.- Parameters:
ser
- fully qualified class and method name of serializer- Throws:
JiBXException
- if serializer not found or not usable
-
setWhitespaceConverter
Set whitespace converter for conversion. This override of the base class method sets a flag to indicate that values must be read from a document as text and converted as a separate step after executing the base class processing.- Overrides:
setWhitespaceConverter
in classStringConversion
- Parameters:
wsconv
- fully qualified class and method name of whitespace converter- Throws:
JiBXException
- if whitespace converter not found or not usable
-
setDeserializer
Set deserializer for conversion. This override of the base class method sets a flag to indicate that values must be read from a document as text and converted as a separate step after executing the base class processing.- Overrides:
setDeserializer
in classStringConversion
- Parameters:
deser
- fully qualified class and method name of deserializer- Throws:
JiBXException
- if deserializer not found or not usable
-
derive
public StringConversion derive(String type, String ser, String conv, String dser, String dflt) throws JiBXException Derive from existing formatting information. This allows constructing a new instance from an existing format of the same or an ancestor type, with the properties of the existing format copied to the new instance except where overridden by the supplied values.- Specified by:
derive
in classStringConversion
- Parameters:
type
- fully qualified name of class handled by conversion (null
if inherited)ser
- fully qualified name of serialization method (null
if inherited)conv
- fully qualified name of whitespace conversion method (null
if inherited)dser
- fully qualified name of deserialization method (null
if inherited)dflt
- default value text (null
if inherited)- Returns:
- new instance initialized from existing one
- Throws:
JiBXException
- if error in configuration information
-