SupportedAnnotationTypes.java revision 2571:10fc81ac75b4 
1/*
2 * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package javax.annotation.processing;
27
28import java.lang.annotation.*;
29import static java.lang.annotation.RetentionPolicy.*;
30import static java.lang.annotation.ElementType.*;
31
32/**
33 * An annotation used to indicate what annotation types an annotation
34 * processor supports.  The {@link
35 * Processor#getSupportedAnnotationTypes} method can construct its
36 * result from the value of this annotation, as done by {@link
37 * AbstractProcessor#getSupportedAnnotationTypes}.  Only {@linkplain
38 * Processor#getSupportedAnnotationTypes strings conforming to the
39 * grammar} should be used as values.
40 *
41 * @author Joseph D. Darcy
42 * @author Scott Seligman
43 * @author Peter von der Ahé
44 * @since 1.6
45 */
46@Documented
47@Target(TYPE)
48@Retention(RUNTIME)
49public @interface SupportedAnnotationTypes {
50    /**
51     * Returns the names of the supported annotation types.
52     * @return the names of the supported annotation types
53     */
54    String [] value();
55}
56