Class CurrencyTransform

java.lang.Object
org.simpleframework.xml.transform.CurrencyTransform
All Implemented Interfaces:
Transform<Currency>

class CurrencyTransform extends Object implements Transform<Currency>
The CurrencyTransform is used to transform currency 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 Currency currency;
    
 
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.
  • Constructor Details

    • CurrencyTransform

      CurrencyTransform()
  • Method Details

    • read

      public Currency read(String symbol)
      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<Currency>
      Parameters:
      symbol - the string representation of the currency
      Returns:
      this returns an appropriate instanced to be used
    • write

      public String write(Currency currency)
      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<Currency>
      Parameters:
      currency - this is the value to be converted to a string
      Returns:
      this is the string representation of the given value