Package org.jibx.binding.def
Class ObjectStringConversion
java.lang.Object
org.jibx.binding.def.StringConversion
org.jibx.binding.def.ObjectStringConversion
Object string conversion handling. Defines serialization handling for
converting objects to and from a
String
value. The default is
to just use the object toString()
method for serialization and
a constructor from a String
value for deserialization.
java.lang.String
itself is a special case, with no added code
used by default for either serializing or deserializing.
java.lang.Object
is also a special case, with no added code
used by default for deserializing (the String
value is used
directly). Other classes must either implement toString()
and
a constructor from String
, or use custom serializers and/or
deserializers.- Author:
- Dennis M. Sosnoski
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String
private ClassItem
Initializer used for creating instance fromString
(only used if no conversion needed and no deserializer supplied; may benull
)private ClassItem
toString()
method for converting instance toString
(only used if conversion needed and no serializer supplied; may benull
)private boolean
Flag for conversion fromString
needed (type is anything other thanString
orObject
)private boolean
Flag for conversion toString
needed (type is anything other thanString
)private static final String
private static final String
private static final String
private static final String
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
ConstructorsConstructorDescriptionObjectStringConversion
(Object dflt, String ser, String deser, String type) Constructor.ObjectStringConversion
(String type, ObjectStringConversion 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.void
genToText
(String type, ContextMethodBuilder mb) Shared code generation for converting instance of type toString
.private void
initMethods
(boolean require) Initialize methods used for conversion of types without serializer or deserializer.boolean
Check if the type handled by this conversion is of a primitive type.Methods inherited from class org.jibx.binding.def.StringConversion
genPopValues, genWriteOptional, genWriteRequired, genWriteText, getTypeName, setDeserializer, setSerializer, setWhitespaceConverter
-
Field Details
-
TOSTRING_METHOD
- See Also:
-
TOSTRING_SIGNATURE
- See Also:
-
FROMSTRING_SIGNATURE
- See Also:
-
NAME_METHOD
- See Also:
-
NAME_SIGNATURE
- See Also:
-
m_needDeserialize
private boolean m_needDeserializeFlag for conversion fromString
needed (type is anything other thanString
orObject
) -
m_initFromString
Initializer used for creating instance fromString
(only used if no conversion needed and no deserializer supplied; may benull
) -
m_needSerialize
private boolean m_needSerializeFlag for conversion toString
needed (type is anything other thanString
) -
m_instToString
toString()
method for converting instance toString
(only used if conversion needed and no serializer supplied; may benull
)
-
-
Constructor Details
-
ObjectStringConversion
ObjectStringConversion(String type, ObjectStringConversion inherit) throws JiBXException Constructor. Initializes conversion handling based on the supplied inherited handling.- Parameters:
type
- fully qualified name of class handled by conversioninherit
- conversion information inherited by this conversion- Throws:
JiBXException
- if error in configuration
-
ObjectStringConversion
Constructor. Initializes conversion handling based on argument values. This form is only used for constructing the default set of conversions. Because of this, it throws an unchecked exception on error.- Parameters:
dflt
- default value object (wrapped value for primitive types, otherwiseString
)ser
- fully qualified name of serialization method (null
if none)deser
- fully qualified name of deserialization method (null
if none)type
- fully qualified name of class handled by conversion
-
-
Method Details
-
initMethods
Initialize methods used for conversion of types without serializer or deserializer. Sets flags for types needed, with errors thrown at time of attempted use rather than at definition time. That offers the advantages of simpler handling (we don't need to know which directions are supported in a binding) and more flexibility (can support nested partial definitions cleanly).- Parameters:
require
- class loading required flag- Throws:
JiBXException
-
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- Throws:
JiBXException
-
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 converted 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
-
genToText
Shared code generation for converting instance of type toString
. This override of the base class method checks for serialization using thetoString
method and implements that case directly, while calling the base class method for normal handling. The code generated by this method assumes that the reference to the instance to be converted is on the stack. It consumes the reference, replacing it with the correspondingString
value.- Overrides:
genToText
in classStringConversion
- Parameters:
type
- fully qualified class name for value on stackmb
- marshal 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
-
isPrimitive
public boolean isPrimitive()Check if the type handled by this conversion is of a primitive type.- Specified by:
isPrimitive
in classStringConversion
- Returns:
false
to indicate object type
-
convertDefault
Convert text representation into default value object. For object types this just returns the text value.- Specified by:
convertDefault
in classStringConversion
- Parameters:
text
- value representation to be converted- Returns:
- converted default value object
- Throws:
JiBXException
- on conversion error
-
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
-