Enum GroovydocAccess

java.lang.Object
java.lang.Enum<GroovydocAccess>
org.gradle.api.tasks.javadoc.GroovydocAccess
All Implemented Interfaces:
Serializable, Comparable<GroovydocAccess>, java.lang.constant.Constable

public enum GroovydocAccess extends Enum<GroovydocAccess>
Represents the setting for the access levels that are included in the Groovydoc.

Each level include all less restrictive access levels, e.g. PACKAGE also includes items with protected and public access.

Since:
7.5
  • Enum Constant Details

  • Method Details

    • values

      public static GroovydocAccess[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static GroovydocAccess 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