JavadocOutputLevel (Gradle API 1.0-milestone-3)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

org.gradle.external.javadoc
Enum JavadocOutputLevel

java.lang.Object
  java.lang.Enum<JavadocOutputLevel>
      org.gradle.external.javadoc.JavadocOutputLevel

All Implemented Interfaces:: Serializable, Comparable<JavadocOutputLevel>

public enum JavadocOutputLevel
extends Enum<JavadocOutputLevel>
extends Enum<JavadocOutputLevel>

This enum maps to the -verbose and -quiet options of the javadoc executable.

Enum Constant Summary
`QUIET` -quiet Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.
`VERBOSE` -verbose Provides more detailed messages while javadoc is running.

Method Summary
`static JavadocOutputLevel`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static JavadocOutputLevel[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

VERBOSE

public static final JavadocOutputLevel VERBOSE

-verbose Provides more detailed messages while javadoc is running. Without the verbose option, messages appear for loading the source files, generating the documentation (one message per source file), and sorting. The verbose option causes the printing of additional messages specifying the number of milliseconds to parse each java source file.

QUIET

public static final JavadocOutputLevel QUIET

-quiet Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view. Also suppresses the version string.

Method Detail

values

public static JavadocOutputLevel[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JavadocOutputLevel c : JavadocOutputLevel.values())
    System.out.println(c);

Returns:: an array containing the constants of this enum type, in the order they are declared

valueOf

public static JavadocOutputLevel valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:: name - the name of the enum constant to be returned.
Returns:: the enum constant with the specified name
Throws:: IllegalArgumentException - if this enum type has no constant with the specified name; NullPointerException - if the argument is null