gw.gosudoc.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 gosu-doc Show documentation

Generates Javadoc-compatible documentation for Gosu projects

There is a newer version: 1.18.2

/*
 * This file is a shadowed version of the older javadoc codebase on which gosudoc is based; borrowed from jdk 9.
 */

package gw.gosudoc.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();
}