Package org.apache.commons.cli

Class DeprecatedAttributes.Builder

java.lang.Object

org.apache.commons.cli.DeprecatedAttributes.Builder

All Implemented Interfaces:

java.util.function.Supplier<DeprecatedAttributes>

Enclosing class:

DeprecatedAttributes

public static class DeprecatedAttributes.Builder
extends java.lang.Object
implements java.util.function.Supplier<DeprecatedAttributes>

Builds DeprecatedAttributes.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	description	The description.
private boolean	forRemoval	Whether this option is subject to removal in a future version.
private java.lang.String	since	The version in which the option became deprecated.

Constructor Summary

Constructors

Constructor	Description
Builder()	Deprecated. Use DeprecatedAttributes.builder().

Method Summary

Modifier and Type	Method	Description
DeprecatedAttributes	get()
DeprecatedAttributes.Builder	setDescription(java.lang.String description)	Sets the description.
DeprecatedAttributes.Builder	setForRemoval(boolean forRemoval)	Sets whether this option is subject to removal in a future version.
DeprecatedAttributes.Builder	setSince(java.lang.String since)	Sets the version in which the option became deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

description

private java.lang.String description

The description.

forRemoval

private boolean forRemoval

Whether this option is subject to removal in a future version.

See Also:

Deprecated.forRemoval

since

private java.lang.String since

The version in which the option became deprecated.

See Also:

Deprecated.since

Constructor Detail

Builder

@Deprecated
public Builder()

Deprecated.

Use DeprecatedAttributes.builder().

Constructs a new instance.

Method Detail

get

public DeprecatedAttributes get()

Specified by:

get in interface java.util.function.Supplier<DeprecatedAttributes>

setDescription

public DeprecatedAttributes.Builder setDescription(java.lang.String description)

Sets the description.

Parameters:

description - the description.

Returns:

this instance.

setForRemoval

public DeprecatedAttributes.Builder setForRemoval(boolean forRemoval)

Sets whether this option is subject to removal in a future version.

Parameters:

forRemoval - whether this is subject to removal in a future version.

Returns:

this instance.

See Also:

Deprecated.forRemoval

setSince

public DeprecatedAttributes.Builder setSince(java.lang.String since)

Sets the version in which the option became deprecated.

Parameters:

since - the version in which the option became deprecated.

Returns:

this instance.