Class LocaleTransform

java.lang.Object
org.simpleframework.xml.transform.LocaleTransform
All Implemented Interfaces:
Transform<Locale>

class LocaleTransform extends Object implements Transform<Locale>
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
    Modifier and Type
    Field
    Description
    private final Pattern
    This is the pattern used to split the parts of the locale.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Constructor for the LocaleTransform object.
  • Method Summary

    Modifier and Type
    Method
    Description
    read(String locale)
    This method is used to convert the string value given to an appropriate representation.
    private Locale
    read(String[] locale)
    This method is used to convert the string value given to an appropriate representation.
    write(Locale locale)
    This method is used to convert the provided value into an XML usable format.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • pattern

      private final Pattern pattern
      This is the pattern used to split the parts of the locale.
  • Constructor Details

    • LocaleTransform

      public LocaleTransform()
      Constructor for the LocaleTransform 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

      public Locale read(String locale) throws 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.
      Specified by:
      read in interface Transform<Locale>
      Parameters:
      locale - the string representation of the date value
      Returns:
      this returns an appropriate instanced to be used
      Throws:
      Exception
    • read

      private Locale read(String[] locale) throws 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:
      Exception
    • write

      public String write(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.
      Specified by:
      write in interface Transform<Locale>
      Parameters:
      locale - this is the value to be converted to a string
      Returns:
      this is the string representation of the given date