Class LocaleTransform
java.lang.Object
org.simpleframework.xml.transform.LocaleTransform
The
LocaleTransform
is used to transform locale
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 Locale locale;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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThis method is used to convert the string value given to an appropriate representation.private Locale
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.
-
Field Details
-
pattern
This is the pattern used to split the parts of the locale.
-
-
Constructor Details
-
LocaleTransform
public LocaleTransform()Constructor for theLocaleTransform
object. This is used to create a transform that will convert locales to and from string representations. The representations use the Java locale representation of language, country, and varient.
-
-
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:
locale
- the string representation of the date value- 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.
-