/*

 * Copyright 2005-2006 Sun Microsystems, Inc.  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.  Sun designates this

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

 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package com.sun.codemodel.internal;

import java.lang.annotation.Annotation;

/**

 * 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);

    /**

     * 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);

}