Package org.eclipse.persistence.oxm.mappings.nullpolicy

Class IsSetNullPolicy

java.lang.Object

org.eclipse.persistence.oxm.mappings.nullpolicy.AbstractNullPolicy

org.eclipse.persistence.oxm.mappings.nullpolicy.IsSetNullPolicy

public class IsSetNullPolicy
extends AbstractNullPolicy

PUBLIC: Description: This null policy allows for various configurations of isSet behavior to be set.
Marshal:
The boolean value of the isSet() state of a node will determine whether a node will be written out for a null value. Unmarshal:

The following instance fields can be set:

• isSetMethodName:
• isSetParameterTypes:
• isSetParameters:

Usage:

• Set to a non-null value
  IsSet==true, value=value
• Not set
  isSet=false, value=null
• Set to null value
  isSet=true, value=null
• Set to default value
  isSet=false, value=default

Since:

Oracle TopLink 11g Release 1 (11.1.1)

See Also:

NullCapableValue

Field Summary

Fields inherited from class org.eclipse.persistence.oxm.mappings.nullpolicy.AbstractNullPolicy

COLON_W_SCHEMA_NIL_ATTRIBUTE, ignoreAttributesForNil, isNullRepresentedByEmptyNode, isNullRepresentedByXsiNil, isSetPerformedForAbsentNode, marshalNullRepresentation, TRUE, XSI_NIL_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
IsSetNullPolicy()	Default Constructor Set the IsSetPerformedForAbsentNode to false to enable the other 2 flags isNullRepresentedByEmptyNode and isNullRepresentedByXsiNil
IsSetNullPolicy(String anIsSetMethodName)	Specific Constructor to set the name for checking the isSet state of the mapping
IsSetNullPolicy(String anIsSetMethodName, boolean bIsNullRepresentedByEmptyNode, boolean bIsNullRepresentedByXsiNil, XMLNullRepresentationType aMarshalNullRepresentation)	Specific Constructor to set both the Marshal enum and the Unmarshal flags.

Method Summary

Modifier and Type	Method	Description
boolean	compositeObjectMarshal(AbstractMarshalRecord record, Object object, Field field, CoreAbstractSession session)	INTERNAL
boolean	compositeObjectMarshal(XPathFragment xPathFragment, MarshalRecord marshalRecord, Object object, CoreSession session, NamespaceResolver namespaceResolver)	INTERNAL
void	directMarshal(Field field, AbstractMarshalRecord record, Object object)	INTERNAL
boolean	directMarshal(XPathFragment xPathFragment, MarshalRecord marshalRecord, Object object, CoreSession session, NamespaceResolver namespaceResolver)	INTERNAL: When using the SAX or DOM Platform, this method is responsible for marshalling null values for the XML Direct Mapping.
String	getIsSetMethodName()
Object[]	getIsSetParameters()
Class[]	getIsSetParameterTypes()
void	setIsSetMethodName(String anIsSetMethodName)
void	setIsSetParameters(Object[] parameters)
void	setIsSetParameterTypes(Class[] parameterTypes)
void	xPathNode(XPathNode xPathNode, NullCapableValue nullCapableValue)	INTERNAL: When using the SAX Platform this allows a NodeValue to be registered to receive events from the TreeObjectBuilder.

Methods inherited from class org.eclipse.persistence.oxm.mappings.nullpolicy.AbstractNullPolicy

getIsSetPerformedForAbsentNode, getMarshalNullRepresentation, ignoreAttributesForNil, isNullRepresentedByEmptyNode, isNullRepresentedByXsiNil, processNamespaceResolverForXSIPrefix, setIgnoreAttributesForNil, setMarshalNullRepresentation, setNullRepresentedByEmptyNode, setNullRepresentedByXsiNil, valueIsNull, valueIsNull

Methods inherited from class java.lang.Object

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

Constructor Detail

IsSetNullPolicy

public IsSetNullPolicy()

Default Constructor Set the IsSetPerformedForAbsentNode to false to enable the other 2 flags isNullRepresentedByEmptyNode and isNullRepresentedByXsiNil

IsSetNullPolicy

public IsSetNullPolicy(String anIsSetMethodName)

Specific Constructor to set the name for checking the isSet state of the mapping

Parameters:

anIsSetMethodName -

IsSetNullPolicy

public IsSetNullPolicy(String anIsSetMethodName,
                       boolean bIsNullRepresentedByEmptyNode,
                       boolean bIsNullRepresentedByXsiNil,
                       XMLNullRepresentationType aMarshalNullRepresentation)

Specific Constructor to set both the Marshal enum and the Unmarshal flags.

Parameters:

anIsSetMethodName -

bIsNullRepresentedByEmptyNode -

bIsNullRepresentedByXsiNil -

aMarshalNullRepresentation -

Method Detail

directMarshal

public boolean directMarshal(XPathFragment xPathFragment,
                             MarshalRecord marshalRecord,
                             Object object,
                             CoreSession session,
                             NamespaceResolver namespaceResolver)

Description copied from class: AbstractNullPolicy

INTERNAL: When using the SAX or DOM Platform, this method is responsible for marshalling null values for the XML Direct Mapping.

Overrides:

directMarshal in class AbstractNullPolicy

Returns:

true if this method caused any nodes to be marshaled, else false.

directMarshal

public void directMarshal(Field field,
                          AbstractMarshalRecord record,
                          Object object)

INTERNAL

Overrides:

directMarshal in class AbstractNullPolicy

compositeObjectMarshal

public boolean compositeObjectMarshal(XPathFragment xPathFragment,
                                      MarshalRecord marshalRecord,
                                      Object object,
                                      CoreSession session,
                                      NamespaceResolver namespaceResolver)

INTERNAL

Overrides:

compositeObjectMarshal in class AbstractNullPolicy

Returns:

true if this method caused any nodes to be marshaled, else false.

compositeObjectMarshal

public boolean compositeObjectMarshal(AbstractMarshalRecord record,
                                      Object object,
                                      Field field,
                                      CoreAbstractSession session)

INTERNAL

Overrides:

compositeObjectMarshal in class AbstractNullPolicy

Returns:

true if this method caused any objects to be marshaled, else false.

xPathNode

public void xPathNode(XPathNode xPathNode,
                      NullCapableValue nullCapableValue)

Description copied from class: AbstractNullPolicy

INTERNAL: When using the SAX Platform this allows a NodeValue to be registered to receive events from the TreeObjectBuilder.

Specified by:

xPathNode in class AbstractNullPolicy

getIsSetMethodName

public String getIsSetMethodName()

Returns:

setIsSetMethodName

public void setIsSetMethodName(String anIsSetMethodName)

Parameters:

anIsSetMethodName -

getIsSetParameterTypes

public Class[] getIsSetParameterTypes()

Returns:

setIsSetParameterTypes

public void setIsSetParameterTypes(Class[] parameterTypes)

Parameters:

parameterTypes -

getIsSetParameters

public Object[] getIsSetParameters()

Returns:

setIsSetParameters

public void setIsSetParameters(Object[] parameters)

Parameters:

parameters -