Module io.helidon.builder.api

Package io.helidon.builder.api

package io.helidon.builder.api

Support for handling the generation of code for Helidon builders and configured builders. The starting point is Prototype.Blueprint that is used on a package local interface. This will generate an interface, builder, and an implementation.

A few things to note:

• The target type that is annotated with the blueprint annotation should have all getter-like methods.
• Any static or default method will be ignored during APT processing.

Class	Description
Description	Custom description.
GeneratedBuilder	Types used from generated code.
GeneratedBuilder.EqualityUtil	Utility methods for equals and hash code of specific cases of field types.
Option	Prototype option annotations.
Option.Access	Customize access modifier for builder methods.
Option.AllowedValue	Can be used to define a list of possible values of an option.
Option.AllowedValues	Allowed values for this option.
Option.Confidential	Mark a getter method as confidential - not suitable to be used in clear text in toString method.
Option.Configured	Mark a prototype option as one that can be read from Config.
Option.Decorator	Define an option decorator.
Option.Default	A String default value for a prototype option.
Option.DefaultBoolean	A boolean default value for a prototype option.
Option.DefaultCode	A default value that will be copied verbatim into the sources.
Option.DefaultDouble	A double default value for a prototype option.
Option.DefaultInt	An integer default value for a prototype option.
Option.DefaultLong	A long default value for a prototype option.
Option.DefaultMethod	A default value created from a method for a prototype option.
Option.Deprecated	Mark an option as deprecated.
Option.Provider	Mark option as sourced from a ServiceLoader.
Option.Redundant	Mark a getter method as redundant - not important for equals, hashcode, and/or toString.
Option.Required	Mark option as a required option.
Option.SameGeneric	Useful for marking map properties, where the key and value must have the same generic type.
Option.Singular	Applying this annotation to a Prototype.Blueprint-annotated interface method will cause the generated class to also include additional "add*()" methods.
Option.Type	Explicitly define a type (may include generics) in case the type is located in the same module, and cannot be inferred correctly by the annotation processor.
Prototype	Prototype is generated from a prototype blueprint, and it is expected to be part of the public API of the module.
Prototype.Annotated	Adding this annotation in conjunction with the Prototype.Blueprint on a target interface type or method causes the Prototype.Annotated.value() be added to the generated implementation class and methods respectfully.
Prototype.Api	Marker interface for the prototype API, usually a generated interface.
Prototype.Blueprint	A package local type (by design) that defines getter methods and possible static factory methods that form prototype information that is generated through annotation processing.
Prototype.Builder<BUILDER,PROTOTYPE>	Terminating method of this builder that creates a prototype instance.
Prototype.BuilderDecorator<T>	Provides a contract by which the Prototype.Blueprint annotated type can be decorated.
Prototype.BuilderMethod	Annotated static method of a custom methods type to be added to builder.
Prototype.Configured	A blueprint annotated with this annotation will create a prototype that can be created from a Config instance.
Prototype.ConfiguredBuilder<BUILDER,PROTOTYPE>	Extension of Prototype.Builder that supports configuration.
Prototype.Constant	Annotated constant of a custom methods type to be added to prototype interface.
Prototype.CustomMethods	Additional methods from this type will be added to the prototype and its builder.
Prototype.Factory<T>	A prototype Prototype.Blueprint may extend this interface to explicitly reference the associated runtime type.
Prototype.FactoryMethod	This is an annotation used by Helidon code generator that marks a static method as a factory method.
Prototype.Implement	Add additional interfaces to implement by the prototype.
Prototype.OptionDecorator<B,T>	Provides a way to decorate a single option when it is applied to the builder.
Prototype.PrototypeMethod	Annotated static method of a custom methods type to be added to prototype interface.
Prototype.Provides	Types provided by this configured type.
Prototype.RegistrySupport	Generate support for Service Registry (helidon-service-registry) for any option that is annotated as Option.Provider.
RuntimeType	This class holds all types related to runtime types, configured from prototypes.
RuntimeType.Api<T extends Prototype.Api>	This type is created from a specific prototype.
RuntimeType.PrototypedBy	Mark this runtime type as prototyped by a specific prototype.