Module org.eclipse.persistence.core

Package org.eclipse.persistence.oxm.mappings

Enum UnmarshalKeepAsElementPolicy

java.lang.Object

java.lang.Enum<UnmarshalKeepAsElementPolicy>

org.eclipse.persistence.oxm.mappings.UnmarshalKeepAsElementPolicy

All Implemented Interfaces:

Serializable, Comparable<UnmarshalKeepAsElementPolicy>, java.lang.constant.Constable, UnmarshalKeepAsElementPolicy

public enum UnmarshalKeepAsElementPolicy
extends Enum<UnmarshalKeepAsElementPolicy>
implements UnmarshalKeepAsElementPolicy

Purpose: Used in conjunction with XMLAnyObject/CollectionMapping and XMLCompositeObject/CollectionMapping to specify when (if at all) to keep parts of the unmarshalled document as nodes.

UnmarshalKeepAsElementPolicy

KEEP_ALL_AS_ELEMENT	Any xml matching this mapping will be brough into the object model as a node.
KEEP_UNKNOWN_AS_ELEMENT	Any XML with an unknown type that matches the mapping in question will be a kept as an element. Those with a known type will be processed normally.
KEEP_NONE_AS_ELEMENT	No xml shall be brought into the object as an element. Elements with unknown types will be ignored

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
KEEP_ALL_AS_ELEMENT
KEEP_NONE_AS_ELEMENT
KEEP_UNKNOWN_AS_ELEMENT

Method Summary

Modifier and Type	Method	Description
boolean	isKeepAllAsElement()
boolean	isKeepNoneAsElement()
boolean	isKeepUnknownAsElement()
static UnmarshalKeepAsElementPolicy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static UnmarshalKeepAsElementPolicy[]	values()	Returns an array containing the constants of this enum type, 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

KEEP_ALL_AS_ELEMENT

public static final UnmarshalKeepAsElementPolicy KEEP_ALL_AS_ELEMENT

KEEP_NONE_AS_ELEMENT

public static final UnmarshalKeepAsElementPolicy KEEP_NONE_AS_ELEMENT

KEEP_UNKNOWN_AS_ELEMENT

public static final UnmarshalKeepAsElementPolicy KEEP_UNKNOWN_AS_ELEMENT

Method Details

values

public static UnmarshalKeepAsElementPolicy[] values()

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

Returns:

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

valueOf

public static UnmarshalKeepAsElementPolicy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

isKeepAllAsElement

public boolean isKeepAllAsElement()

Specified by:

isKeepAllAsElement in interface UnmarshalKeepAsElementPolicy

isKeepNoneAsElement

public boolean isKeepNoneAsElement()

Specified by:

isKeepNoneAsElement in interface UnmarshalKeepAsElementPolicy

isKeepUnknownAsElement

public boolean isKeepUnknownAsElement()

Specified by:

isKeepUnknownAsElement in interface UnmarshalKeepAsElementPolicy