Module eclipselink

Package org.eclipse.persistence.oxm.annotations

Enum Class XmlMarshalNullRepresentation

java.lang.Object

java.lang.Enum<XmlMarshalNullRepresentation>

org.eclipse.persistence.oxm.annotations.XmlMarshalNullRepresentation

All Implemented Interfaces:

Serializable, Comparable<XmlMarshalNullRepresentation>, Constable

public enum XmlMarshalNullRepresentation
extends Enum<XmlMarshalNullRepresentation>

This enumeration provides a means of specifying how a null value in a java object should be marshalled to XML. The possible options are:

• XSI_NIL - This means that the element should be written out with an xsi:nil attribute. Example: <element xsi:nil="true"/>.
• EMPTY_NODE - This indicates that the element should be written out to xml with no contents Example: <element />.
• ABSENT_NODE - Absent node means that no element should be written to XML if null is encountered.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABSENT_NODE	Null element should not be written out.
EMPTY_NODE	Null element should be written out to xml as an element with no contents.
XSI_NIL	Null element should be written out as an element with an xsi:nil attribute.

Method Summary

Modifier and Type	Method	Description
static XmlMarshalNullRepresentation	fromValue(String v)
String	value()
static XmlMarshalNullRepresentation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static XmlMarshalNullRepresentation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

XSI_NIL

public static final XmlMarshalNullRepresentation XSI_NIL

Null element should be written out as an element with an xsi:nil attribute.

ABSENT_NODE

public static final XmlMarshalNullRepresentation ABSENT_NODE

Null element should not be written out.

EMPTY_NODE

public static final XmlMarshalNullRepresentation EMPTY_NODE

Null element should be written out to xml as an element with no contents.

Method Details

values

public static XmlMarshalNullRepresentation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static XmlMarshalNullRepresentation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

fromValue

public static XmlMarshalNullRepresentation fromValue(String v)