Interface OptionDeprecation

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

OptionDeprecation.BuilderBase.OptionDeprecationImpl

public interface OptionDeprecation
extends Prototype.Api

Deprecated option information.

See Also:

• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	OptionDeprecation.Builder	Fluent API builder for OptionDeprecation.
static class	OptionDeprecation.BuilderBase<BUILDER extends OptionDeprecation.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends OptionDeprecation>	Fluent API builder base for OptionDeprecation.

Method Summary

Modifier and Type	Method	Description
Optional<String>	alternative()	Name of the option to use instead of this one.
static OptionDeprecation.Builder	builder()	Create a new fluent API builder to customize configuration.
static OptionDeprecation.Builder	builder(OptionDeprecation instance)	Create a new fluent API builder from an existing instance.
boolean	forRemoval()	If this is scheduled for removal, defaults to true.
String	message()	Deprecation message.
Optional<String>	since()	Version that deprecated this option.

Method Details

builder

static OptionDeprecation.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static OptionDeprecation.Builder builder(OptionDeprecation instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

message

String message()

Deprecation message.

Returns:

deprecation message

forRemoval

boolean forRemoval()

If this is scheduled for removal, defaults to true.

Returns:

whether scheduled for removal

alternative

Optional<String> alternative()

Name of the option to use instead of this one.

Returns:

alternative option name

since

Optional<String> since()

Version that deprecated this option.

Returns:

since version