Class LocaleTransform
- java.lang.Object
-
- org.simpleframework.xml.transform.LocaleTransform
-
- All Implemented Interfaces:
Transform<java.util.Locale>
class LocaleTransform extends java.lang.Object implements Transform<java.util.Locale>
TheLocaleTransform
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 theCycleStrategy
object.
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.regex.Pattern
pattern
This is the pattern used to split the parts of the locale.
-
Constructor Summary
Constructors Constructor Description LocaleTransform()
Constructor for theLocaleTransform
object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Locale
read(java.lang.String locale)
This method is used to convert the string value given to an appropriate representation.private java.util.Locale
read(java.lang.String[] locale)
This method is used to convert the string value given to an appropriate representation.java.lang.String
write(java.util.Locale locale)
This method is used to convert the provided value into an XML usable format.
-
-
-
Method Detail
-
read
public java.util.Locale read(java.lang.String locale) throws java.lang.Exception
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
private java.util.Locale read(java.lang.String[] locale) throws java.lang.Exception
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:
java.lang.Exception
-
write
public java.lang.String write(java.util.Locale locale)
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.
-
-