XMLMapping (EclipseLink 2.7.14, API Reference)

All Superinterfaces:

org.eclipse.persistence.internal.oxm.mappings.Mapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLRecord>

All Known Implementing Classes:

XMLAnyAttributeMapping, XMLAnyCollectionMapping, XMLAnyObjectMapping, XMLBinaryDataCollectionMapping, XMLBinaryDataMapping, XMLChoiceCollectionMapping, XMLChoiceObjectMapping, XMLCollectionReferenceMapping, XMLCompositeCollectionMapping, XMLCompositeDirectCollectionMapping, XMLCompositeObjectMapping, XMLDirectMapping, XMLFragmentCollectionMapping, XMLFragmentMapping, XMLObjectReferenceMapping, XMLTransformationMapping, XMLVariableXPathCollectionMapping, XMLVariableXPathObjectMapping
```
public interface XMLMapping
extends org.eclipse.persistence.internal.oxm.mappings.Mapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLRecord>
```
INTERNAL All mappings which can be added to org.eclipse.persistence.oxm.XMLDescriptor must implement this interface.

See Also:

org.eclipse.persistence.oxm.mappings

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`convertClassNamesToClasses(java.lang.ClassLoader classLoader)`
`boolean`	`isWriteOnly()`
`void`	`setIsWriteOnly(boolean b)`
`void`	`writeSingleValue(java.lang.Object value, java.lang.Object parent, XMLRecord record, org.eclipse.persistence.internal.sessions.AbstractSession session)`	INTERNAL: A method that marshals a single value to the provided Record based on this mapping's XPath.

Methods inherited from interface org.eclipse.persistence.internal.oxm.mappings.Mapping
getAttributeAccessor, getAttributeClassification, getAttributeName, getAttributeValueFromObject, getContainerPolicy, getDescriptor, getField, getReferenceDescriptor, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isCollectionMapping, isReadOnly, isReferenceMapping, isTransformationMapping, setAttributeAccessor, setAttributeName, setAttributeValueInObject, setGetMethodName, setIsReadOnly, setProperties, setSetMethodName

- Method Detail
  - convertClassNamesToClasses
```
void convertClassNamesToClasses(java.lang.ClassLoader classLoader)
```
    Specified by:
    
    convertClassNamesToClasses in interface org.eclipse.persistence.internal.oxm.mappings.Mapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLRecord>
  - writeSingleValue
```
void writeSingleValue(java.lang.Object value,
                      java.lang.Object parent,
                      XMLRecord record,
                      org.eclipse.persistence.internal.sessions.AbstractSession session)
```
    INTERNAL: A method that marshals a single value to the provided Record based on this mapping's XPath. Used for Sequenced marshalling.
    
    Specified by:
    
    writeSingleValue in interface org.eclipse.persistence.internal.oxm.mappings.Mapping<org.eclipse.persistence.internal.sessions.AbstractSession,AttributeAccessor,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField,XMLRecord>
    
    Parameters:
    
    value - - The value to be marshalled
    
    record - - The Record the value is being marshalled too.
  - isWriteOnly
```
boolean isWriteOnly()
```
  - setIsWriteOnly
```
void setIsWriteOnly(boolean b)
```