XMLRootConverter (EclipseLink 2.4.3, build 'v20150722-6e43db3' API Reference)

java.lang.Object
- org.eclipse.persistence.oxm.mappings.converters.XMLRootConverter

All Implemented Interfaces:

java.io.Serializable, Converter, XMLConverter
```
public class XMLRootConverter
extends java.lang.Object
implements XMLConverter
```
Purpose: Provides an implementation of XMLConverter to wrap/unwrap objects in an XMLRoot in order to capture element name information.
Responsibilities
Wrap an object in an XMLRoot on unmarshal. Do any required conversions based on type for simple mappings.
Unwrap an XMLRoot from the object and pass it along to be marshalled.

See Also:: XMLConverter, Converter, Serialized Form

Constructor Summary

Constructors
Constructor and Description

XMLRootConverter(XMLField associatedField)

Constructors
Constructor and Description
`XMLRootConverter(XMLField associatedField)`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Object`	`convertDataValueToObjectValue(java.lang.Object dataValue, Session session)` PUBLIC: Convert the databases' data representation of the value to the object's representation.
`java.lang.Object`	`convertDataValueToObjectValue(java.lang.Object dataValue, Session session, XMLUnmarshaller unmarshaller)`
`java.lang.Object`	`convertObjectValueToDataValue(java.lang.Object objectValue, Session session)` PUBLIC: Convert the object's representation of the value to the databases' data representation.
`java.lang.Object`	`convertObjectValueToDataValue(java.lang.Object objectValue, Session session, XMLMarshaller marshaller)`
`void`	`initialize(DatabaseMapping mapping, Session session)` PUBLIC: Allow for any initialization.
`boolean`	`isMutable()` PUBLIC: If the converter converts the value to a mutable value, i.e.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - XMLRootConverter
```
public XMLRootConverter(XMLField associatedField)
```
- Method Detail
  - convertDataValueToObjectValue
```
public java.lang.Object convertDataValueToObjectValue(java.lang.Object dataValue,
                                             Session session,
                                             XMLUnmarshaller unmarshaller)
```
    Specified by:
    
    convertDataValueToObjectValue in interface XMLConverter
  - convertObjectValueToDataValue
```
public java.lang.Object convertObjectValueToDataValue(java.lang.Object objectValue,
                                             Session session,
                                             XMLMarshaller marshaller)
```
    Specified by:
    
    convertObjectValueToDataValue in interface XMLConverter
  - convertDataValueToObjectValue
```
public java.lang.Object convertDataValueToObjectValue(java.lang.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
  - convertObjectValueToDataValue
```
public java.lang.Object convertObjectValueToDataValue(java.lang.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
  - initialize
```
public void initialize(DatabaseMapping mapping,
              Session session)
```
    Description copied from interface: Converter
    
    PUBLIC: Allow for any initialization.
    
    Specified by:
    
    initialize in interface Converter
  - 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

Class XMLRootConverter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XMLRootConverter

Method Detail

convertDataValueToObjectValue

convertObjectValueToDataValue

convertDataValueToObjectValue

convertObjectValueToDataValue

initialize

isMutable