Package org.eclipse.persistence.oxm.mappings.converters

Class XMLListConverter

java.lang.Object
org.eclipse.persistence.oxm.mappings.converters.XMLListConverter
All Implemented Interfaces:
Serializable, CoreConverter<DatabaseMapping,Session>, Converter
public class XMLListConverter extends Object implements Converter

Purpose: Provides an implementation of Converter that can be used to convert a collection of Objects into a space separated list of Strings and back. Used with XMLCompositeDirectCollectionMapping to implement the behaviour of the XmlList annotation

See Also:

  • Constructor Details

    • XMLListConverter

      public XMLListConverter()

  • Method Details

    • convertDataValueToObjectValue

      public Object convertDataValueToObjectValue(Object dataValue, Session session)
      Description copied from interface: Converter
      PUBLIC: Convert the databases' data representation of the value to the object's representation. For example this could convert between an sql.Time datatype and the Java Calendar type.
      Specified by:
      convertDataValueToObjectValue in interface Converter
      Specified by:
      convertDataValueToObjectValue in interface CoreConverter<DatabaseMapping,Session>

    • convertObjectValueToDataValue

      public Object convertObjectValueToDataValue(Object objectValue, Session session)
      Description copied from interface: Converter
      PUBLIC: Convert the object's representation of the value to the databases' data representation. For example this could convert between a Calendar Java type and the sql.Time datatype.
      Specified by:
      convertObjectValueToDataValue in interface Converter
      Specified by:
      convertObjectValueToDataValue in interface CoreConverter<DatabaseMapping,Session>

    • initialize

      public void initialize(DatabaseMapping mapping, Session session)
      Description copied from interface: Converter
      PUBLIC: Allow for any initialization.
      Specified by:
      initialize in interface Converter
      Specified by:
      initialize in interface CoreConverter<DatabaseMapping,Session>

    • isMutable

      public boolean isMutable()
      Description copied from interface: Converter
      PUBLIC: If the converter converts the value to a mutable value, i.e. a value that can have its' parts changed without being replaced, then it must return true. If the value is not mutable, cannot be changed without replacing the whole value then false must be returned. This is used within the UnitOfWork to determine how to clone.
      Specified by:
      isMutable in interface Converter

    • getObjectClassName

      public String getObjectClassName()
      Get the Class name of the elements of this collection's "sub-collection". Only applicable for DirectCollections of Lists (for example, for an ArrayList<ArrayList<Double>>, FieldSubElementClassName would be "java.lang.Double").
      Returns:
      String the name of the Class of the elements of this collection's "sub-collection"

    • setObjectClassName

      public void setObjectClassName(String aClassName)
      Set the Class name of the elements of this collection's "sub-collection". Only applicable for DirectCollections of Lists (for example, for an ArrayList<ArrayList<Double>>, FieldSubElementClassName would be "java.lang.Double").
      Parameters:
      aClassName - the name of the Class of the elements of this collection's "sub-collection"

    • getObjectClass

      public Class getObjectClass()
      Get the Class of the elements of this collection's "sub-collection". Only applicable for DirectCollections of Lists (for example, for an ArrayList<ArrayList<Double>>, FieldSubElementClass would be java.lang.Double.class).
      Returns:
      Class the Class of the elements of this collection's "sub-collection"

    • setObjectClass

      public void setObjectClass(Class aClass)
      Set the Class of the elements of this collection's "sub-collection". Only applicable for DirectCollections of Lists (for example, for an ArrayList<ArrayList<Double>>, FieldSubElementClass would be java.lang.Double.class).
      Parameters:
      aClass - the Class of the elements of this collection's "sub-collection"