Module io.helidon.common.features.metadata

Package io.helidon.common.features.metadata

Interface FeatureMetadata

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

FeatureMetadata.BuilderBase.FeatureMetadataImpl

public interface FeatureMetadata
extends Prototype.Api

Metadata of a feature, as stored in one of the Helidon specific files FeatureRegistry.FEATURE_REGISTRY_LOCATION_V1 or FeatureRegistry.FEATURE_REGISTRY_LOCATION_V2.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Optional<Aot>	aot()	Ahead of time compilation information (native-image).
static FeatureMetadata.Builder	builder()	Create a new fluent API builder to customize configuration.
static FeatureMetadata.Builder	builder(FeatureMetadata instance)	Create a new fluent API builder from an existing instance.
static FeatureMetadata	create()	Create a new instance with default values.
Optional<Deprecation>	deprecation()	Deprecation information.
Optional<String>	description()	Feature description.
List<Flavor>	flavors()	Which flavor(s) should print this feature.
List<Flavor>	invalidFlavors()	In which flavor we should warn that this feature is present on classpath.
String	module()	Module name.
String	name()	Feature name.
List<String>	path()	Feature path.
Optional<String>	since()	First version of Helidon this feature was in.
FeatureStatus	status()	Feature status.
default String	stringPath()	String representation of the path(), using forward slash as a separator.
default Hson.Struct	toHson()	Create the metadata in Helidon metadata format.

Method Details

builder

static FeatureMetadata.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static FeatureMetadata.Builder builder(FeatureMetadata 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 FeatureMetadata create()

Create a new instance with default values.

Returns:

a new instance

module

String module()

Module name.

Returns:

module name

name

String name()

Feature name.

Returns:

feature name

description

Optional<String> description()

Feature description.

Returns:

description

path

List<String> path()

Feature path.

Returns:

path

since

Optional<String> since()

First version of Helidon this feature was in.

Returns:

since version

flavors

List<Flavor> flavors()

Which flavor(s) should print this feature.

Returns:

flavors

invalidFlavors

List<Flavor> invalidFlavors()

In which flavor we should warn that this feature is present on classpath.

Returns:

flavors

aot

Optional<Aot> aot()

Ahead of time compilation information (native-image).

Returns:

AOT information

deprecation

Optional<Deprecation> deprecation()

Deprecation information.

Returns:

deprecation info

status

FeatureStatus status()

Feature status.

Returns:

status

toHson

default Hson.Struct toHson()

Create the metadata in Helidon metadata format. This is used by components that store the metadata.

Returns:

HSON object (simplified JSON)

stringPath

default String stringPath()

String representation of the path(), using forward slash as a separator.

Returns:

string path representation