Class CharacterArrayTransform
java.lang.Object
org.simpleframework.xml.transform.CharacterArrayTransform
- All Implemented Interfaces:
Transform
The
CharacterArrayTransform
is used to transform text
values to and from string representations, which will be inserted
in the generated XML document as the value place holder. The
value must be readable and writable in the same format. Fields
and methods annotated with the XML attribute annotation will use
this to persist and retrieve the value to and from the XML source.
@Attribute private char[] text;As well as the XML attribute values using transforms, fields and methods annotated with the XML element annotation will use this. Aside from the obvious difference, the element annotation has an advantage over the attribute annotation in that it can maintain any references using the
CycleStrategy
object.-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCharacterArrayTransform
(Class entry) Constructor for thePrimitiveArrayTransform
object. -
Method Summary
Modifier and TypeMethodDescriptionprivate Object
read
(char[] list, int length) This method is used to convert the string value given to an appropriate representation.This method is used to convert the string value given to an appropriate representation.This method is used to convert the provided value into an XML usable format.private String
This method is used to convert the provided value into an XML usable format.
-
Field Details
-
entry
This is the entry type for the primitive array to be created.
-
-
Constructor Details
-
CharacterArrayTransform
Constructor for thePrimitiveArrayTransform
object. This is used to create a transform that will create primitive arrays and populate the values of the array with values from a comma separated list of individual values for the entry type.- Parameters:
entry
- this is the entry component type for the array
-
-
Method Details
-
read
This method is used to convert the string value given to an appropriate representation. This is used when an object is being deserialized from the XML document and the value for the string representation is required. -
read
This method is used to convert the string value given to an appropriate representation. This is used when an object is being deserialized from the XML document and the value for the string representation is required.- Parameters:
list
- this is the string representation of the valuelength
- this is the number of string values to use- Returns:
- this returns an appropriate instanced to be used
- Throws:
Exception
-
write
This method is used to convert the provided value into an XML usable format. This is used in the serialization process when there is a need to convert a field value in to a string so that that value can be written as a valid XML entity. -
write
This method is used to convert the provided value into an XML usable format. This is used in the serialization process when there is a need to convert a field value in to a string so that that value can be written as a valid XML entity.- Parameters:
value
- this is the value to be converted to a string- Returns:
- this is the string representation of the given value
- Throws:
Exception
-