org.mapstruct.ap.prism

Class XmlElementDeclPrism

java.lang.Object

org.mapstruct.ap.prism.XmlElementDeclPrism

public class XmlElementDeclPrism
extends Object

A Prism representing an @javax.xml.bind.annotation.XmlElementDecl annotation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XmlElementDeclPrism.Values A class whose members corespond to those of javax.xml.bind.annotation.XmlElementDecl but which each return the AnnotationValue corresponding to that member in the model of the annotations.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isValid Determine whether the underlying AnnotationMirror has no errors.
AnnotationMirror	mirror The underlying AnnotationMirror of the annotation represented by this Prism.
XmlElementDeclPrism.Values	values An instance of the Values inner class whose methods return the AnnotationValues used to build this prism.

Method Summary

Methods

Modifier and Type	Method and Description
String	defaultValue() Returns a String representing the value of the java.lang.String defaultValue() member of the Annotation.
static XmlElementDeclPrism	getInstance(AnnotationMirror mirror) Return a prism of the @javax.xml.bind.annotation.XmlElementDecl annotation whose mirror is mirror.
static XmlElementDeclPrism	getInstanceOn(Element e) Return a prism representing the @javax.xml.bind.annotation.XmlElementDecl annotation on 'e'.
String	name() Returns a String representing the value of the java.lang.String name() member of the Annotation.
String	namespace() Returns a String representing the value of the java.lang.String namespace() member of the Annotation.
TypeMirror	scope() Returns a TypeMirror representing the value of the java.lang.Class scope() member of the Annotation.
String	substitutionHeadName() Returns a String representing the value of the java.lang.String substitutionHeadName() member of the Annotation.
String	substitutionHeadNamespace() Returns a String representing the value of the java.lang.String substitutionHeadNamespace() member of the Annotation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

values

public final XmlElementDeclPrism.Values values

An instance of the Values inner class whose methods return the AnnotationValues used to build this prism. Primarily intended to support using Messager.

isValid

public final boolean isValid

Determine whether the underlying AnnotationMirror has no errors. True if the underlying AnnotationMirror has no errors. When true is returned, none of the methods will return null. When false is returned, a least one member will either return null, or another prism that is not valid.

mirror

public final AnnotationMirror mirror

The underlying AnnotationMirror of the annotation represented by this Prism. Primarily intended to support using Messager.

Method Detail

getInstanceOn

public static XmlElementDeclPrism getInstanceOn(Element e)

Return a prism representing the @javax.xml.bind.annotation.XmlElementDecl annotation on 'e'. similar to e.getAnnotation(javax.xml.bind.annotation.XmlElementDecl.class) except that an instance of this class rather than an instance of javax.xml.bind.annotation.XmlElementDecl is returned.

getInstance

public static XmlElementDeclPrism getInstance(AnnotationMirror mirror)

Return a prism of the @javax.xml.bind.annotation.XmlElementDecl annotation whose mirror is mirror.

scope

public TypeMirror scope()

Returns a TypeMirror representing the value of the java.lang.Class scope() member of the Annotation.

See Also:

XmlElementDecl.scope()

namespace

public String namespace()

Returns a String representing the value of the java.lang.String namespace() member of the Annotation.

See Also:

XmlElementDecl.namespace()

name

public String name()

Returns a String representing the value of the java.lang.String name() member of the Annotation.

See Also:

XmlElementDecl.name()

substitutionHeadNamespace

public String substitutionHeadNamespace()

Returns a String representing the value of the java.lang.String substitutionHeadNamespace() member of the Annotation.

See Also:

XmlElementDecl.substitutionHeadNamespace()

substitutionHeadName

public String substitutionHeadName()

Returns a String representing the value of the java.lang.String substitutionHeadName() member of the Annotation.

See Also:

XmlElementDecl.substitutionHeadName()

defaultValue

public String defaultValue()

Returns a String representing the value of the java.lang.String defaultValue() member of the Annotation.

See Also:

XmlElementDecl.defaultValue()