Package org.apache.rat.api

Enum EnvVar

java.lang.Object
java.lang.Enum<EnvVar>
org.apache.rat.api.EnvVar
All Implemented Interfaces:
Serializable, Comparable<EnvVar>
public enum EnvVar extends Enum<EnvVar>

  • Enum Constant Details

    • RAT_NO_GIT_GLOBAL_IGNORE

      public static final EnvVar RAT_NO_GIT_GLOBAL_IGNORE
      Ignore Git Global ignore file.

    • RAT_DECOMPOSE_MATCHER_ON_USE

      public static final EnvVar RAT_DECOMPOSE_MATCHER_ON_USE
      Log matcher decomposition when used.

    • XDG_CONFIG_HOME

      public static final EnvVar XDG_CONFIG_HOME
      Defines the XDG home.

    • HOME

      public static final EnvVar HOME
      Defines the user HOME.

    • RAT_DEFAULT_LOG_LEVEL

      public static final EnvVar RAT_DEFAULT_LOG_LEVEL
      Sets the log level for the DefaultLog when it is constructed.

  • Method Details

    • values

      public static EnvVar[] 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 EnvVar 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

    • documentation

      public String documentation()
      Gets the documentation for this EnvVar.
      Returns:
      the documentation for this EnvVar.

    • isSet

      public boolean isSet()
      Determines if this EnvVar is set.
      Returns:
      true if the EnvVar is set.

    • getValue

      public String getValue()
      Gets the value for the EnvVar.
      Returns:
      the value for this EnvVar or null if not set.