View Javadoc
1   /*
2    * Copyright (c) 1997, 2010, 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  
26  package com.sun.codemodel.internal;
27  
28  import java.lang.annotation.Annotation;
29  import java.util.Collection;
30  
31  /**
32   * Annotatable program elements.
33   *
34   * @author Kohsuke Kawaguchi
35   */
36  public interface JAnnotatable {
37      /**
38       * Adds an annotation to this program element.
39       * @param clazz
40       *          The annotation class to annotate the program element with
41       */
42      JAnnotationUse annotate(JClass clazz);
43  
44      /**
45       * Adds an annotation to this program element.
46       *
47       * @param clazz
48       *          The annotation class to annotate the program element with
49       */
50      JAnnotationUse annotate(Class <? extends Annotation> clazz);
51  
52      /**
53       * Adds an annotation to this program element
54       * and returns a type-safe writer to fill in the values of such annotations.
55       */
56      <W extends JAnnotationWriter> W annotate2(Class<W> clazz);
57  
58      /**
59       * Read-only live view of all annotations on this {@link JAnnotatable}
60       *
61       * @return
62       *      Can be empty but never null.
63       */
64      Collection<JAnnotationUse> annotations();
65  }