Module io.helidon.builder.codegen

Package io.helidon.builder.codegen

Interface PrototypeConfigured

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

PrototypeConfigured.BuilderBase.PrototypeConfiguredImpl

public interface PrototypeConfigured
extends Prototype.Api

Configuration information for a prototype.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PrototypeConfigured.Builder	builder()	Create a new fluent API builder to customize configuration.
static PrototypeConfigured.Builder	builder(PrototypeConfigured instance)	Create a new fluent API builder from an existing instance.
static PrototypeConfigured	create()	Create a new instance with default values.
AccessModifier	createAccessModifier()	Access modifier.
Optional<String>	key()	Key of this prototype's configuration.
boolean	root()	Whether the configuration is expected from the root of config tree.

Method Details

builder

static PrototypeConfigured.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

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

Create a new instance with default values.

Returns:

a new instance

createAccessModifier

AccessModifier createAccessModifier()

Access modifier.

Returns:

access modifier of the method create(Config), defaults to public

root

boolean root()

Whether the configuration is expected from the root of config tree. Defaults to true in case a key() is defined.

Returns:

whether this prototype uses root configuration key

key

Optional<String> key()

Key of this prototype's configuration.

Returns:

key if configured