Java™ Platform
Standard Ed. 6

javax.lang.model.util
Class SimpleAnnotationValueVisitor6<R,P>

java.lang.Object
  extended by javax.lang.model.util.AbstractAnnotationValueVisitor6<R,P>
      extended by javax.lang.model.util.SimpleAnnotationValueVisitor6<R,P>
Type Parameters:
R - the return type of this visitor's methods
P - the type of the additional parameter to this visitor's methods.
All Implemented Interfaces:
AnnotationValueVisitor<R,P>

@SupportedSourceVersion(value=RELEASE_6)
public class SimpleAnnotationValueVisitor6<R,P>
extends AbstractAnnotationValueVisitor6<R,P>

A simple visitor for annotation values with default behavior appropriate for the RELEASE_6 source version. Visit methods call defaultAction(java.lang.Object, P) passing their arguments to defaultAction's corresponding parameters.

Methods in this class may be overridden subject to their general contract. Note that annotating methods in concrete subclasses with @Override will help ensure that methods are overridden as intended.

WARNING: The AnnotationValueVisitor interface implemented by this class may have methods added to it in the future to accommodate new, currently unknown, language structures added to future versions of the Java™ programming language. Therefore, methods whose names begin with "visit" may be added to this class in the future; to avoid incompatibilities, classes which extend this class should not declare any instance methods with names beginning with "visit".

When such a new visit method is added, the default implementation in this class will be to call the visitUnknown method. A new simple annotation value visitor class will also be introduced to correspond to the new language level; this visitor will have different default behavior for the visit method in question. When the new visitor is introduced, all or portions of this visitor may be deprecated.

Since:
1.6

Field Summary
protected  R DEFAULT_VALUE
          Default value to be returned; defaultAction returns this value unless the method is overridden.
 
Constructor Summary
protected SimpleAnnotationValueVisitor6()
          Constructor for concrete subclasses; uses null for the default value.
protected SimpleAnnotationValueVisitor6(R defaultValue)
          Constructor for concrete subclasses; uses the argument for the default value.
 
Method Summary
protected  R defaultAction(Object o, P p)
          The default action for visit methods.
 R visitAnnotation(AnnotationMirror a, P p)
          Visits an annotation value in an annotation.
 R visitArray(List<? extends AnnotationValue> vals, P p)
          Visits an array value in an annotation.
 R visitBoolean(boolean b, P p)
          Visits a boolean value in an annotation.
 R visitByte(byte b, P p)
          Visits a byte value in an annotation.
 R visitChar(char c, P p)
          Visits a char value in an annotation.
 R visitDouble(double d, P p)
          Visits a double value in an annotation.
 R visitEnumConstant(VariableElement c, P p)
          Visits an enum value in an annotation.
 R visitFloat(float f, P p)
          Visits a float value in an annotation.
 R visitInt(int i, P p)
          Visits an int value in an annotation.
 R visitLong(long i, P p)
          Visits a long value in an annotation.
 R visitShort(short s, P p)
          Visits a short value in an annotation.
 R visitString(String s, P p)
          Visits a string value in an annotation.
 R visitType(TypeMirror t, P p)
          Visits a type value in an annotation.
 
Methods inherited from class javax.lang.model.util.AbstractAnnotationValueVisitor6
visit, visit, visitUnknown
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_VALUE

protected final R DEFAULT_VALUE
Default value to be returned; defaultAction returns this value unless the method is overridden.

Constructor Detail

SimpleAnnotationValueVisitor6

protected SimpleAnnotationValueVisitor6()
Constructor for concrete subclasses; uses null for the default value.


SimpleAnnotationValueVisitor6

protected SimpleAnnotationValueVisitor6(R defaultValue)
Constructor for concrete subclasses; uses the argument for the default value.

Parameters:
defaultValue - the value to assign to DEFAULT_VALUE
Method Detail

defaultAction

protected R defaultAction(Object o,
                          P p)
The default action for visit methods. The implementation in this class just returns DEFAULT_VALUE; subclasses will commonly override this method.

Parameters:
o - the value of the annotation
p - a visitor-specified parameter
Returns:
DEFAULT_VALUE unless overridden

visitBoolean

public R visitBoolean(boolean b,
                      P p)
Visits a boolean value in an annotation. This implementation calls defaultAction.

Parameters:
b - the value being visited
p - a visitor-specified parameter
Returns:
the result of defaultAction

visitByte

public R visitByte(byte b,
                   P p)
Visits a byte value in an annotation. This implementation calls defaultAction.

Parameters:
b - the value being visited
p - a visitor-specified parameter
Returns:
the result of defaultAction

visitChar

public R visitChar(char c,
                   P p)
Visits a char value in an annotation. This implementation calls defaultAction.

Parameters:
c - the value being visited
p - a visitor-specified parameter
Returns:
the result of defaultAction

visitDouble

public R visitDouble(double d,
                     P p)
Visits a double value in an annotation. This implementation calls defaultAction.

Parameters:
d - the value being visited
p - a visitor-specified parameter
Returns:
the result of defaultAction

visitFloat

public R visitFloat(float f,
                    P p)
Visits a float value in an annotation. This implementation calls defaultAction.

Parameters:
f - the value being visited
p - a visitor-specified parameter
Returns:
the result of defaultAction

visitInt

public R visitInt(int i,
                  P p)
Visits an int value in an annotation. This implementation calls defaultAction.

Parameters:
i - the value being visited
p - a visitor-specified parameter
Returns:
the result of defaultAction

visitLong

public R visitLong(long i,
                   P p)
Visits a long value in an annotation. This implementation calls defaultAction.

Parameters:
i - the value being visited
p - a visitor-specified parameter
Returns:
the result of defaultAction

visitShort

public R visitShort(short s,
                    P p)
Visits a short value in an annotation. This implementation calls defaultAction.

Parameters:
s - the value being visited
p - a visitor-specified parameter
Returns:
the result of defaultAction

visitString

public R visitString(String s,
                     P p)
Visits a string value in an annotation. This implementation calls defaultAction.

Parameters:
s - the value being visited
p - a visitor-specified parameter
Returns:
the result of defaultAction

visitType

public R visitType(TypeMirror t,
                   P p)
Visits a type value in an annotation. This implementation calls defaultAction.

Parameters:
t - the value being visited
p - a visitor-specified parameter
Returns:
the result of defaultAction

visitEnumConstant

public R visitEnumConstant(VariableElement c,
                           P p)
Visits an enum value in an annotation. This implementation calls defaultAction.

Parameters:
c - the value being visited
p - a visitor-specified parameter
Returns:
the result of defaultAction

visitAnnotation

public R visitAnnotation(AnnotationMirror a,
                         P p)
Visits an annotation value in an annotation. This implementation calls defaultAction.

Parameters:
a - the value being visited
p - a visitor-specified parameter
Returns:
the result of defaultAction

visitArray

public R visitArray(List<? extends AnnotationValue> vals,
                    P p)
Visits an array value in an annotation. This implementation calls defaultAction.

Parameters:
vals - the value being visited
p - a visitor-specified parameter
Returns:
the result of defaultAction

Java™ Platform
Standard Ed. 6

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.