Package jakarta.xml.bind.annotation

Enum Class XmlAccessType

java.lang.Object

java.lang.Enum<XmlAccessType>

jakarta.xml.bind.annotation.XmlAccessType

All Implemented Interfaces:

Serializable, Comparable<XmlAccessType>, Constable

public enum XmlAccessType
extends Enum<XmlAccessType>

Used by XmlAccessorType to control serialization of fields or properties.

Since:

1.6, JAXB 2.0

See Also:

• XmlAccessorType

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
FIELD	Every non static, non transient field in a Jakarta XML Binding-bound class will be automatically bound to XML, unless annotated by XmlTransient.
NONE	None of the fields or properties is bound to XML unless they are specifically annotated with some of the Jakarta XML Binding annotations.
PROPERTY	Every getter/setter pair in a Jakarta XML Binding-bound class will be automatically bound to XML, unless annotated by XmlTransient.
PUBLIC_MEMBER	Every public getter/setter pair and every public field will be automatically bound to XML, unless annotated by XmlTransient.

Method Summary

Modifier and Type	Method	Description
static XmlAccessType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static XmlAccessType[]	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

PROPERTY

public static final XmlAccessType PROPERTY

Every getter/setter pair in a Jakarta XML Binding-bound class will be automatically bound to XML, unless annotated by XmlTransient. Fields are bound to XML only when they are explicitly annotated by some of the Jakarta XML Binding annotations.

FIELD

public static final XmlAccessType FIELD

Every non static, non transient field in a Jakarta XML Binding-bound class will be automatically bound to XML, unless annotated by XmlTransient. Getter/setter pairs are bound to XML only when they are explicitly annotated by some of the Jakarta XML Binding annotations.

PUBLIC_MEMBER

public static final XmlAccessType PUBLIC_MEMBER

Every public getter/setter pair and every public field will be automatically bound to XML, unless annotated by XmlTransient. Fields or getter/setter pairs that are private, protected, or defaulted to package-only access are bound to XML only when they are explicitly annotated by the appropriate Jakarta XML Binding annotations.

NONE

public static final XmlAccessType NONE

None of the fields or properties is bound to XML unless they are specifically annotated with some of the Jakarta XML Binding annotations.

Method Details

values

public static XmlAccessType[] 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 XmlAccessType 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