oracle.toplink.ox.mappings.nullpolicy
Class AbstractNullPolicy

java.lang.Object
  oracle.toplink.ox.mappings.nullpolicy.AbstractNullPolicy

Direct Known Subclasses:

IsSetNullPolicy, NullPolicy

public abstract class AbstractNullPolicy
extends java.lang.Object

Description: This node null policy allows for the handling of various representations of null in XML documents.

Null policies have 2 concrete implementations:

• NullPolicy (default implementation)
• IsSetNullPolicy (keyed off isSet() state of the node)

Unmarshal Flag	Description
isSetPerformedForAbsentNode	This umarshal flag represents whether a set is done for absent nodes only.
isNullRepresentedByEmptyNode	If this unmarshal flag is false for empty nodes we set an empty Object for composite mappings, otherwise we set to null.
isNullRepresentedByXsiNil	If this unmarshal flag is false for xsi:nil nodes we ignore the xsi:nil attribute and treat as an empty node. Otherwise we set to null.

Marshal Enum	XMLNullRepresentationType Description
XSI_NIL	Nillable: Write out an xsi:nil="true" attribute.
ABSENT_NODE(default)	Optional: Write out no node.
EMPTY_NODE	Required: Write out an empty or node="" node.

Usage:

Since:

Oracle TopLink 11g Release 1 (11.1.1)

See Also:

oracle.toplink.internal.ox.NullCapableValue

Constructor Summary

AbstractNullPolicy()

Method Summary

boolean	getIsSetPerformedForAbsentNode()
XMLNullRepresentationType	getMarshalNullRepresentation() Get the enum that determines what XML to write when a null value is encountered.
boolean	isNullRepresentedByEmptyNode()
boolean	isNullRepresentedByXsiNil()
void	setMarshalNullRepresentation(XMLNullRepresentationType anEnumInstance) Set the enum that determines what XML to write when a null value is encountered.
void	setNullRepresentedByEmptyNode(boolean bisNullRepresentedByEmptyNode)
void	setNullRepresentedByXsiNil(boolean bIsNullRepresentedByXsiNil)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractNullPolicy

public AbstractNullPolicy()

Method Detail

getMarshalNullRepresentation

public XMLNullRepresentationType getMarshalNullRepresentation()

Get the enum that determines what XML to write when a null value is encountered.

Parameters:

enumValue -

setMarshalNullRepresentation

public void setMarshalNullRepresentation(XMLNullRepresentationType anEnumInstance)

Set the enum that determines what XML to write when a null value is encountered.

Parameters:

enumValue -

getIsSetPerformedForAbsentNode

public boolean getIsSetPerformedForAbsentNode()

Returns:

the isSetPerformedForAbsentNode flag

isNullRepresentedByEmptyNode

public boolean isNullRepresentedByEmptyNode()

Returns:

setNullRepresentedByEmptyNode

public void setNullRepresentedByEmptyNode(boolean bisNullRepresentedByEmptyNode)

Parameters:

bIsNullRepresentedByEmptyNode -

isNullRepresentedByXsiNil

public boolean isNullRepresentedByXsiNil()

Returns:

setNullRepresentedByXsiNil

public void setNullRepresentedByXsiNil(boolean bIsNullRepresentedByXsiNil)

Parameters:

isNullRepresentedByXsiNil -