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.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final DeprecatedAttributes	DEFAULT	The default value for a DeprecatedAttributes.
private final String	description	The description.
private static final String	EMPTY_STRING	The empty string.
private final boolean	forRemoval	Whether this option will be removed.
private final String	since	The version label for removal.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DeprecatedAttributes(String description, String since, boolean forRemoval)	Constructs a new instance.

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.
private String	toEmpty(String since)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

static final DeprecatedAttributes DEFAULT

The default value for a DeprecatedAttributes.

EMPTY_STRING

private static final String EMPTY_STRING

The empty string.

See Also:

• Constant Field Values

description

private final String description

The description.

forRemoval

private final boolean forRemoval

Whether this option will be removed.

since

private final String since

The version label for removal.

Constructor Details

DeprecatedAttributes

private DeprecatedAttributes(String description,
 String since,
 boolean forRemoval)

Constructs a new instance.

Parameters:

description - The description.

since - The version label for removal.

forRemoval - Whether this option will be removed.

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.

toEmpty

private String toEmpty(String since)

toString

public String toString()

Overrides:

toString in class Object