EclipseLink1.0 - 20080707 API Reference

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

java.lang.Object
  extended by org.eclipse.persistence.oxm.mappings.nullpolicy.AbstractNullPolicy
      extended by 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:

 Usage:

See Also:
NullCapableValue
Since:
Oracle TopLink 11g Release 1 (11.1.1)

Field Summary
 
Fields inherited from class org.eclipse.persistence.oxm.mappings.nullpolicy.AbstractNullPolicy
COLON_W_SCHEMA_NIL_ATTRIBUTE, EMPTY_STRING, isNullRepresentedByEmptyNode, isNullRepresentedByXsiNil, isSetPerformedForAbsentNode, marshalNullRepresentation, TRUE, XSI_NIL_ATTRIBUTE
 
Constructor Summary
IsSetNullPolicy()
          Default Constructor Set the IsSetPerformedForAbsentNode to false to enable the other 2 flags isNullRepresentedByEmptyNode and isNullRepresentedByXsiNil
IsSetNullPolicy(java.lang.String anIsSetMethodName)
          Specific Constructor to set the name for checking the isSet state of the mapping
IsSetNullPolicy(java.lang.String anIsSetMethodName, boolean bIsNullRepresentedByEmptyNode, boolean bIsNullRepresentedByXsiNil, XMLNullRepresentationType aMarshalNullRepresentation)
          Specific Constructor to set both the Marshal enum and the Unmarshal flags.
 
Method Summary
 boolean compositeObjectMarshal(XMLRecord record, java.lang.Object object, XMLField field, org.eclipse.persistence.internal.sessions.AbstractSession session)
          INTERNAL: When using the DOM Platform, this method is responsible for marshalling null values for the XML Composite Object Mapping.
 boolean compositeObjectMarshal(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment, MarshalRecord marshalRecord, java.lang.Object object, Session session, NamespaceResolver namespaceResolver)
          INTERNAL: When using the SAX Platform, this method is responsible for marshalling null values for the XML Composite Object Mapping.
 boolean directMarshal(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment, MarshalRecord marshalRecord, java.lang.Object object, Session session, NamespaceResolver namespaceResolver)
          INTERNAL: When using the SAX or DOM Platform, this method is responsible for marshalling null values for the XML Direct Mapping.
 java.lang.String getIsSetMethodName()
           
 java.lang.Object[] getIsSetParameters()
           
 java.lang.Class[] getIsSetParameterTypes()
           
 void setIsSetMethodName(java.lang.String anIsSetMethodName)
           
 void setIsSetParameters(java.lang.Object[] parameters)
           
 void setIsSetParameterTypes(java.lang.Class[] parameterTypes)
           
 void xPathNode(org.eclipse.persistence.internal.oxm.XPathNode xPathNode, org.eclipse.persistence.internal.oxm.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, isNullRepresentedByEmptyNode, isNullRepresentedByXsiNil, processNamespaceResolverForXSIPrefix, 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(java.lang.String anIsSetMethodName)
Specific Constructor to set the name for checking the isSet state of the mapping

Parameters:
anIsSetMethodName -

IsSetNullPolicy

public IsSetNullPolicy(java.lang.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(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
                             MarshalRecord marshalRecord,
                             java.lang.Object object,
                             Session 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.

compositeObjectMarshal

public boolean compositeObjectMarshal(org.eclipse.persistence.internal.oxm.XPathFragment xPathFragment,
                                      MarshalRecord marshalRecord,
                                      java.lang.Object object,
                                      Session session,
                                      NamespaceResolver namespaceResolver)
Description copied from class: AbstractNullPolicy
INTERNAL: When using the SAX Platform, this method is responsible for marshalling null values for the XML Composite Object Mapping.

Overrides:
compositeObjectMarshal in class AbstractNullPolicy
Returns:
true if this method caused any nodes to be marshaled, else false.

compositeObjectMarshal

public boolean compositeObjectMarshal(XMLRecord record,
                                      java.lang.Object object,
                                      XMLField field,
                                      org.eclipse.persistence.internal.sessions.AbstractSession session)
Description copied from class: AbstractNullPolicy
INTERNAL: When using the DOM Platform, this method is responsible for marshalling null values for the XML Composite Object Mapping.

Overrides:
compositeObjectMarshal in class AbstractNullPolicy
Returns:
true if this method caused any objects to be marshaled, else false.

xPathNode

public void xPathNode(org.eclipse.persistence.internal.oxm.XPathNode xPathNode,
                      org.eclipse.persistence.internal.oxm.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 java.lang.String getIsSetMethodName()
Returns:

setIsSetMethodName

public void setIsSetMethodName(java.lang.String anIsSetMethodName)
Parameters:
isSetMethodName -

getIsSetParameterTypes

public java.lang.Class[] getIsSetParameterTypes()
Returns:

setIsSetParameterTypes

public void setIsSetParameterTypes(java.lang.Class[] parameterTypes)
Parameters:
parameterTypes -

getIsSetParameters

public java.lang.Object[] getIsSetParameters()
Returns:

setIsSetParameters

public void setIsSetParameters(java.lang.Object[] parameters)
Parameters:
parameters -

EclipseLink1.0 - 20080707 API Reference