/*

 * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code 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

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.codemodel.internal;

import java.lang.annotation.Annotation;

import java.util.Collection;

/**

 * Annotatable program elements.

 *

 * @author Kohsuke Kawaguchi

 */

public interface JAnnotatable {

    /**

     * Adds an annotation to this program element.

     * @param clazz

     *          The annotation class to annotate the program element with

     */

    JAnnotationUse annotate(JClass clazz);

    /**

     * Adds an annotation to this program element.

     *

     * @param clazz

     *          The annotation class to annotate the program element with

     */

    JAnnotationUse annotate(Class <? extends Annotation> clazz);

    /**

     * Removes annotation from this program element.

     *

     * @param annotation

     *          The annotation to be removed from the program element

     */

    boolean removeAnnotation(JAnnotationUse annotation);

    /**

     * Adds an annotation to this program element

     * and returns a type-safe writer to fill in the values of such annotations.

     */

    <W extends JAnnotationWriter> W annotate2(Class<W> clazz);

    /**

     * Read-only live view of all annotations on this {@link JAnnotatable}

     *

     * @return

     *      Can be empty but never null.

     */

    Collection<JAnnotationUse> annotations();

}