Module io.helidon.common.features.metadata

Package io.helidon.common.features.metadata

Interface Deprecation

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

Deprecation.BuilderBase.DeprecationImpl

public interface Deprecation
extends Prototype.Api

Deprecation information.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static Deprecation.Builder	builder()	Create a new fluent API builder to customize configuration.
static Deprecation.Builder	builder(Deprecation instance)	Create a new fluent API builder from an existing instance.
static Deprecation	create()	Create a new instance with default values.
Optional<String>	description()	Deprecation description.
boolean	isDeprecated()	Whether this module is deprecated, defaults to true.
Optional<String>	since()	First version this feature was deprecated in.

Method Details

builder

static Deprecation.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static Deprecation.Builder builder(Deprecation 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

create

static Deprecation create()

Create a new instance with default values.

Returns:

a new instance

isDeprecated

boolean isDeprecated()

Whether this module is deprecated, defaults to true.

Returns:

is deprecated

since

Optional<String> since()

First version this feature was deprecated in.

Returns:

since version

description

Optional<String> description()

Deprecation description.

Returns:

description