Top Description Fields Methods
org.eclipse.persistence.internal.oxm.mappings

public Interface XMLContainerMapping

Known Direct Subinterfaces
org.eclipse.persistence.internal.oxm.mappings.AnyAttributeMapping, org.eclipse.persistence.internal.oxm.mappings.AnyCollectionMapping, org.eclipse.persistence.internal.oxm.mappings.BinaryDataCollectionMapping, org.eclipse.persistence.internal.oxm.mappings.ChoiceCollectionMapping, org.eclipse.persistence.internal.oxm.mappings.CollectionReferenceMapping, org.eclipse.persistence.internal.oxm.mappings.CompositeCollectionMapping, org.eclipse.persistence.internal.oxm.mappings.DirectCollectionMapping, org.eclipse.persistence.internal.oxm.mappings.FragmentCollectionMapping, org.eclipse.persistence.internal.oxm.mappings.VariableXPathCollectionMapping
Known Direct Implementers
org.eclipse.persistence.oxm.mappings.XMLVariableXPathCollectionMapping
Imports
org.eclipse.persistence.oxm.mappings.nullpolicy.AbstractNullPolicy

This interface represents behaviour that is common to all XML mappings that involve containers: Collection, Map, Arrays, etc.

Field Summary

Modifier and TypeField and Description
public static final boolean
EMPTY_CONTAINER_DEFAULT

This is the default setting for the defaultEmptyContainer property.

Method Summary

Modifier and TypeMethod and Description
public boolean
getReuseContainer()

Return true if a pre-initialized container already set on the field/property should be used.

public AbstractNullPolicy
getWrapperNullPolicy()

Get the Wrapper NullPolicy from the Mapping.

public boolean
isDefaultEmptyContainer()

Return true if an empty container should be set on the object if there is no presence of the collection in the XML document.

public void
setDefaultEmptyContainer(boolean defaultEmptyContainer)

Indicate whether by default an empty container should be set on the field/property if the collection is not present in the XML document.

public void
setReuseContainer(boolean reuseContainer)

Specify if a pre-existing container on the field/property should be used.

public void
setWrapperNullPolicy(AbstractNullPolicy policy)

Set the Wrapper NullPolicy on the Mapping.

Field Detail

EMPTY_CONTAINER_DEFAULTback to summary
public static final boolean EMPTY_CONTAINER_DEFAULT

This is the default setting for the defaultEmptyContainer property. This can be overridden at the mapping level.

Method Detail

getReuseContainerback to summary
public boolean getReuseContainer()

Return true if a pre-initialized container already set on the field/property should be used. If false a new container will always be created.

getWrapperNullPolicyback to summary
public AbstractNullPolicy getWrapperNullPolicy()

Get the Wrapper NullPolicy from the Mapping.

isDefaultEmptyContainerback to summary
public boolean isDefaultEmptyContainer()

Return true if an empty container should be set on the object if there is no presence of the collection in the XML document.

setDefaultEmptyContainerback to summary
public void setDefaultEmptyContainer(boolean defaultEmptyContainer)

Indicate whether by default an empty container should be set on the field/property if the collection is not present in the XML document.

setReuseContainerback to summary
public void setReuseContainer(boolean reuseContainer)

Specify if a pre-existing container on the field/property should be used.

setWrapperNullPolicyback to summary
public void setWrapperNullPolicy(AbstractNullPolicy policy)

Set the Wrapper NullPolicy on the Mapping.