Module jdk.javadoc
Package jdk.javadoc.doclet

## Enum DocletEnvironment.ModuleMode

- java.lang.Object
- - java.lang.Enum<DocletEnvironment.ModuleMode>
  - - jdk.javadoc.doclet.DocletEnvironment.ModuleMode

- All Implemented Interfaces:
    `Serializable`, `Comparable<DocletEnvironment.ModuleMode>`
  Enclosing interface:
    DocletEnvironment

      public static enum DocletEnvironment.ModuleMode
      extends Enum<DocletEnvironment.ModuleMode>

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant | Description
    --- | ---
    `ALL` | Indicate Detailed documentation is required
    `API` | Indicate API level documentation is required

  - ### Method Summary

    All Methods Static Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `static DocletEnvironment.ModuleMode` | `valueOf​(String name)` | Returns the enum constant of this type with the specified name.
    `static DocletEnvironment.ModuleMode[]` | `values()` | Returns an array containing the constants of this enum type, in the order they are declared.

    - ### Methods declared in class java.lang.Enum

      `clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

    - ### Methods declared in class java.lang.Object

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Enum Constant Detail

    - #### API

          public static final DocletEnvironment.ModuleMode API

      Indicate API level documentation is required

    - #### ALL

          public static final DocletEnvironment.ModuleMode ALL

      Indicate Detailed documentation is required

  - ### Method Detail

    - #### values

          public static DocletEnvironment.ModuleMode[] 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 (DocletEnvironment.ModuleMode c : DocletEnvironment.ModuleMode.values())
              System.out.println(c);

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

    - #### valueOf

          public static DocletEnvironment.ModuleMode 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