Package org.apache.commons.cli

# Class DeprecatedAttributes

java.lang.Object
org.apache.commons.cli.DeprecatedAttributes

public final class DeprecatedAttributes extends Object
Deprecated attributes.

Note: This class isn't called "Deprecated" to avoid clashing with "java.lang.Deprecated".

If you want to serialize this class, use a serialization proxy.

Since:
  1.7.0
See Also:
  - `Deprecated`

- ## Nested Class Summary

  Nested Classes
  Modifier and Type
  Class
  Description
  `static class`
  `DeprecatedAttributes.Builder`
  Builds `DeprecatedAttributes`.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static DeprecatedAttributes.Builder`
  `builder()`
  Creates a new builder.
  `String`
  `getDescription()`
  Gets the descriptions.
  `String`
  `getSince()`
  Gets version in which the option became deprecated.
  `boolean`
  `isForRemoval()`
  Tests whether this option is subject to removal in a future version.
  `String`
  `toString()`

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

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- ## Method Details

  - ### builder

    public static DeprecatedAttributes.Builder builder()
    Creates a new builder.
    Returns:
      a new builder.

  - ### getDescription

    public String getDescription()
    Gets the descriptions.
    Returns:
      the descriptions.

  - ### getSince

    public String getSince()
    Gets version in which the option became deprecated.
    Returns:
      the version in which the option became deprecated.

  - ### isForRemoval

    public boolean isForRemoval()
    Tests whether this option is subject to removal in a future version.
    Returns:
      whether this option is subject to removal in a future version.

  - ### toString

    public String toString()
    Overrides:
      `toString` in class `Object`