XmlAccessType (Java EE 5 SDK) - Java Platform, Enterprise Edition v5.0 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java EE 5 SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

javax.xml.bind.annotation
Enum XmlAccessType

java.lang.Object
  java.lang.Enum<XmlAccessType>
      javax.xml.bind.annotation.XmlAccessType

All Implemented Interfaces:: Serializable, Comparable<XmlAccessType>

public enum XmlAccessType
extends Enum<XmlAccessType>
extends Enum<XmlAccessType>

Used by XmlAccessorType to control serialization of fields or properties.

Since:: JAXB2.0
Version:: $Revision: 1.1 $
Author:: Sekhar Vajjhala, Sun Microsystems, Inc.
See Also:: XmlAccessorType

Enum Constant Summary

FIELD
          Every non static, non transient field in a JAXB-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 JAXB annotations.

PROPERTY
          Every getter/setter pair in a JAXB-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

static XmlAccessType valueOf(String name)
          Returns the enum constant of this type with the specified name.

static XmlAccessType[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Summary
`FIELD` Every non static, non transient field in a JAXB-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 JAXB annotations.
`PROPERTY` Every getter/setter pair in a JAXB-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
`static XmlAccessType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static XmlAccessType[]`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum
`clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`finalize, getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

PROPERTY

public static final XmlAccessType PROPERTY

Every getter/setter pair in a JAXB-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 JAXB annotations.

FIELD

public static final XmlAccessType FIELD

Every non static, non transient field in a JAXB-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 JAXB 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 JAXB 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 JAXB annotations.

Method Detail

values

public static final XmlAccessType[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(XmlAccessType c : XmlAccessType.values())
        System.out.println(c);

Returns:: an array containing the constants of this enum type, in the order they're declared

valueOf

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