Module org.eclipse.persistence.core

Package org.eclipse.persistence.internal.oxm.mappings

Interface XMLContainerMapping

All Known Subinterfaces:

AnyAttributeMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,DESCRIPTOR,FIELD,XML_RECORD>, AnyCollectionMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,SESSION,UNMARSHAL_KEEP_AS_ELEMENT_POLICY,UNMARSHALLER,XML_RECORD>, BinaryDataCollectionMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,MIME_TYPE_POLICY,SESSION,UNMARSHALLER,XML_RECORD>, ChoiceCollectionMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,SESSION,UNMARSHALLER,XML_FIELD,XML_MAPPING,XML_RECORD>, CollectionReferenceMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,DESCRIPTOR,FIELD,UNMARSHAL_RECORD,XML_FIELD,XML_RECORD>, CompositeCollectionMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,SESSION,UNMARSHAL_KEEP_AS_ELEMENT_POLICY,UNMARSHALLER,XML_RECORD>, DirectCollectionMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,SESSION,UNMARSHALLER,XML_RECORD>, FragmentCollectionMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,DESCRIPTOR,FIELD,SESSION,XML_RECORD>, VariableXPathCollectionMapping<ABSTRACT_SESSION,ATTRIBUTE_ACCESSOR,CONTAINER_POLICY,CONVERTER,DESCRIPTOR,FIELD,MARSHALLER,SESSION,UNMARSHALLER,XML_RECORD>

All Known Implementing Classes:

XMLAnyAttributeMapping, XMLAnyCollectionMapping, XMLBinaryDataCollectionMapping, XMLChoiceCollectionMapping, XMLCollectionReferenceMapping, XMLCompositeCollectionMapping, XMLCompositeDirectCollectionMapping, XMLFragmentCollectionMapping, XMLVariableXPathCollectionMapping

public interface XMLContainerMapping

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

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	EMPTY_CONTAINER_DEFAULT	This is the default setting for the defaultEmptyContainer property.

Method Summary

Modifier and Type	Method	Description
boolean	getReuseContainer()	Return true if a pre-initialized container already set on the field/property should be used.
AbstractNullPolicy	getWrapperNullPolicy()	Get the Wrapper NullPolicy from the Mapping.
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.
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.
void	setReuseContainer(boolean reuseContainer)	Specify if a pre-existing container on the field/property should be used.
void	setWrapperNullPolicy(AbstractNullPolicy policy)	Set the Wrapper NullPolicy on the Mapping.

Field Detail

EMPTY_CONTAINER_DEFAULT

static final boolean EMPTY_CONTAINER_DEFAULT

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

See Also:

Constant Field Values

Method Detail

getReuseContainer

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.

getWrapperNullPolicy

AbstractNullPolicy getWrapperNullPolicy()

Get the Wrapper NullPolicy from the Mapping.

isDefaultEmptyContainer

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.

setDefaultEmptyContainer

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.

setReuseContainer

void setReuseContainer(boolean reuseContainer)

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

setWrapperNullPolicy

void setWrapperNullPolicy(AbstractNullPolicy policy)

Set the Wrapper NullPolicy on the Mapping.