com.sun.javadoc.AnnotationValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javac Show documentation

A repackaged copy of javac for Error Prone to depend on

There is a newer version: 9-dev-r4023-3

/*
 * Copyright (c) 2003, 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.javadoc;


/**
 * Represents a value of an annotation type element.
 *
 * @author Scott Seligman
 * @since 1.5
 *
 * @deprecated
 *   The declarations in this package have been superseded by those
 *   in the package {@code jdk.javadoc.doclet}.
 *   For more information, see the Migration Guide in the documentation for that package.
 */
@Deprecated
public interface AnnotationValue {

    /**
     * Returns the value.
     * The type of the returned object is one of the following:
     *  a wrapper class for a primitive type
     *     
 {@code String}
     *     
 {@code Type} (representing a class literal)
     *     
 {@code FieldDoc} (representing an enum constant)
     *     
 {@code AnnotationDesc}
     *     
 {@code AnnotationValue[]}
     * 
     *
     * @return the value.
     */
    Object value();

    /**
     * Returns a string representation of the value.
     *
     * @return the text of a Java language annotation value expression
     *          whose value is the value of this element.
     */
    String toString();
}