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
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.BuilderInterceptor<T>	Provides a contract by which the Prototype.Blueprint annotated type can be intercepted (i.e., including decoration or mutation).
Prototype.BuilderMethod	Annotated static method of a custom methods type to be added to builder.
Prototype.Confidential	Mark a getter method as confidential - not suitable to be used in clear text in toString method.
Prototype.ConfiguredBuilder<BUILDER,PROTOTYPE>	Extension of Prototype.Builder that supports configuration.
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.PrototypeMethod	Annotated static method of a custom methods type to be added to prototype interface.
Prototype.Redundant	Mark a getter method as redundant - not important for equals, hashcode, and/or toString.
Prototype.SameGeneric	Useful for marking map properties, where the key and value must have the same generic type.
Prototype.Singular	Applying this annotation to a Prototype.Blueprint-annotated interface method will cause the generated class to also include additional "add*()" methods.
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.