summaryrefslogtreecommitdiff
path: root/javax/lang/model/element/AnnotationValue.java
blob: d25ce42058bf709dad693b1e5d8d5de39624c07b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
/* AnnotationValue.java -- Represents an annotation value.
   Copyright (C) 2012  Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

package javax.lang.model.element;

/**
 * <p>Represents the value of an element in an annotation.  This
 * may be one of the following types:</p>
 * <ul>
 * <li>a wrapper class for a primitive type (e.g. {@code Integer} 
 * for {@code int}.</li>
 * <li>{@code String}</li>
 * <li>{@code TypeMirror}</li>
 * <li>{@code VariableElement} (an enum constant)</li>
 * <li>{@code AnnotationMirror}</li>
 * <li>{@code List<? extends AnnotationValue>} (an array,
 * with elements in the order they were declared)</li>
 * </ol>
 *
 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
 * @since 1.6
 */
public interface AnnotationValue
{

  /**
   * Applies a visitor to this type.
   *
   * @param <R> the return type of the visitor's methods.
   * @param <P> the type of the additional parameter used in the visitor's
   *            methods.
   * @param visitor the visitor to apply to the element.
   * @param param the additional parameter to be sent to the visitor.
   * @return the return value from the visitor.
   */
  <R,P> R accept(AnnotationValueVisitor<R,P> visitor, P param);

  /**
   * Returns the value.
   *
   * @return the value.
   */
  Object getValue();

  /**
   * Returns a textual representation of the value.
   *
   * @return a textual representation.
   */
  String toString();

}