XmlJavaTypeAdapter (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.xml.bind.annotation.adapters
annotation XmlJavaTypeAdapter

java.lang.annotation.Annotation
  javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter

public interface annotation XmlJavaTypeAdapter
extends Annotation

Use an adapter that implements {@link XmlAdapter} for custom marshaling.

Usage:

The @XmlJavaTypeAdapter annotation can be used with the following program elements:

a JavaBean property
field
parameter
package
from within {@link XmlJavaTypeAdapters}

When @XmlJavaTypeAdapter annotation is defined on a class, it applies to all references to the class.

When @XmlJavaTypeAdapter annotation is defined at the package level it applies to all references from within the package to @XmlJavaTypeAdapter.type().

When @XmlJavaTypeAdapter annotation is defined on the field, property or parameter, then the annotation applies to the field, property or the parameter only.

A @XmlJavaTypeAdapter annotation on a field, property or parameter overrides the @XmlJavaTypeAdapter annotation associated with the class being referenced by the field, property or parameter.

A @XmlJavaTypeAdapter annotation on a class overrides the @XmlJavaTypeAdapter annotation specified at the package level for that class.

This annotation can be used with the following other annotations: {@link XmlElement}, {@link XmlAttribute}, {@link XmlElementRef}, {@link XmlElementRefs}, {@link XmlAnyElement}. This can also be used at the package level with the following annotations: {@link XmlAccessorType}, {@link XmlSchema}, {@link XmlSchemaType}, {@link XmlSchemaTypes}.

Example: See example in {@link XmlAdapter}

Nested Class Summary
`static class`	`XmlJavaTypeAdapter.DEFAULT` Used in javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter.type to signal that the type be inferred from the signature of the field, property, parameter or the class.

Method Summary
`Class`	`type()` If this annotation is used at the package level, then value of the type() must be specified.
`Class`	`value()` Points to the clsss that converts a value type to a bound type or vice versa.

Methods inherited from class java.lang.annotation.Annotation
`annotationType, equals, hashCode, toString`

Method Detail

type

public Class type()

If this annotation is used at the package level, then value of the type() must be specified.

value

public Class value()

Points to the clsss that converts a value type to a bound type or vice versa. See {@link XmlAdapter} for more details.