SafeModeAction (Apache Hadoop Main 3.5.0 API)
Description: declaration: package: org.apache.hadoop.fs, enum: SafeModeAction

Package org.apache.hadoop.fs

# Enum Class SafeModeAction

java.lang.Object
java.lang.Enum<SafeModeAction>
org.apache.hadoop.fs.SafeModeAction

All Implemented Interfaces:
  `Serializable`, `Comparable<SafeModeAction>`, `Constable`

public enum SafeModeAction extends Enum<SafeModeAction>
An identical copy from org.apache.hadoop.hdfs.protocol.HdfsConstants.SafeModeAction, that helps the other file system implementation to define `SafeMode`.

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant
  Description
  `ENTER`
  Starting entering into safe mode.
  `FORCE_EXIT`
  Force Exit from safe mode.
  `GET`
  Get the status of the safe mode.
  `LEAVE`
  Gracefully exit from safe mode.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static SafeModeAction`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static SafeModeAction[]`
  `values()`
  Returns an array containing the constants of this enum class, in the order they are declared.

  ### Methods inherited from class java.lang.Enum

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

  ### Methods inherited from class java.lang.Object

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

- ## Enum Constant Details

  - ### ENTER

    public static final SafeModeAction ENTER
    Starting entering into safe mode.

  - ### LEAVE

    public static final SafeModeAction LEAVE
    Gracefully exit from safe mode.

  - ### FORCE_EXIT

    public static final SafeModeAction FORCE_EXIT
    Force Exit from safe mode.

  - ### GET

    public static final SafeModeAction GET
    Get the status of the safe mode.

- ## Method Details

  - ### values

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

  - ### valueOf

    public static SafeModeAction valueOf(String name)
    Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      `NullPointerException` - if the argument is null