Index
All Classes and Interfaces|All Packages
B
- beanStyle() - Element in annotation interface io.helidon.builder.api.Prototype.Blueprint
-
Whether to use bean style setters and getters, or not (default is not).
- build() - Method in interface io.helidon.builder.api.Prototype.Factory
-
Create a new instance of the runtime type from this config object.
- builderPublic() - Element in annotation interface io.helidon.builder.api.Prototype.Blueprint
-
Builder can be set to be package local only.
- buildPrototype() - Method in interface io.helidon.builder.api.Prototype.Builder
-
Create an instance of the
Prototype.
C
- createEmptyPublic() - Element in annotation interface io.helidon.builder.api.Prototype.Blueprint
-
Method create() is created whenever there are no fields required (or all have default values).
- createFromConfigPublic() - Element in annotation interface io.helidon.builder.api.Prototype.Blueprint
-
Method create(config) is public by default.
D
- decorate(B, T) - Method in interface io.helidon.builder.api.Prototype.OptionDecorator
-
Provides the ability to decorate option as it is being set on the target builder.
- decorate(T) - Method in interface io.helidon.builder.api.Prototype.BuilderDecorator
-
Provides the ability to decorate the target.
- decorator() - Element in annotation interface io.helidon.builder.api.Prototype.Blueprint
-
Used to decorate the builder, right before method build is called.
- description() - Element in annotation interface io.helidon.builder.api.Option.AllowedValue
-
Description of this value, used in documentation, may be used in error handling.
- Description - Annotation Interface in io.helidon.builder.api
-
Custom description.
- discoverServices() - Element in annotation interface io.helidon.builder.api.Option.Provider
-
Whether to discover all services using a service loader by default.
E
- equality() - Element in annotation interface io.helidon.builder.api.Option.Redundant
-
Set to
falseto mark this NOT redundant for equals and hashcode. - EqualityUtil() - Constructor for class io.helidon.builder.api.GeneratedBuilder.EqualityUtil
G
- GeneratedBuilder - Class in io.helidon.builder.api
-
Types used from generated code.
- GeneratedBuilder.EqualityUtil - Class in io.helidon.builder.api
-
Utility methods for equals and hash code of specific cases of field types.
I
- io.helidon.builder.api - module io.helidon.builder.api
-
The Builder API module.
- io.helidon.builder.api - package io.helidon.builder.api
-
Support for handling the generation of code for Helidon builders and configured builders.
- isPublic() - Element in annotation interface io.helidon.builder.api.Prototype.Blueprint
-
The generated interface is public by default.
M
- merge() - Element in annotation interface io.helidon.builder.api.Option.Configured
-
If set to
true, the nested configurable object will not have its own config key, but will use the config of the current configurable object.
O
- Option - Class in io.helidon.builder.api
-
Prototype option annotations.
- Option.Access - Annotation Interface in io.helidon.builder.api
-
Customize access modifier for builder methods.
- Option.AllowedValue - Annotation Interface in io.helidon.builder.api
-
Can be used to define a list of possible values of an option.
- Option.AllowedValues - Annotation Interface in io.helidon.builder.api
-
Allowed values for this option.
- Option.Confidential - Annotation Interface in io.helidon.builder.api
-
Mark a getter method as confidential - not suitable to be used in clear text in
toStringmethod. - Option.Configured - Annotation Interface in io.helidon.builder.api
-
Mark a prototype option as one that can be read from
io.helidon.common.config.Config. - Option.Decorator - Annotation Interface in io.helidon.builder.api
-
Define an option decorator.
- Option.Default - Annotation Interface in io.helidon.builder.api
-
A String default value for a prototype option.
- Option.DefaultBoolean - Annotation Interface in io.helidon.builder.api
-
A boolean default value for a prototype option.
- Option.DefaultCode - Annotation Interface in io.helidon.builder.api
-
A default value that will be copied verbatim into the sources.
- Option.DefaultDouble - Annotation Interface in io.helidon.builder.api
-
A double default value for a prototype option.
- Option.DefaultInt - Annotation Interface in io.helidon.builder.api
-
An integer default value for a prototype option.
- Option.DefaultLong - Annotation Interface in io.helidon.builder.api
-
A long default value for a prototype option.
- Option.DefaultMethod - Annotation Interface in io.helidon.builder.api
-
A default value created from a method for a prototype option.
- Option.Deprecated - Annotation Interface in io.helidon.builder.api
-
Mark an option as deprecated.
- Option.Provider - Annotation Interface in io.helidon.builder.api
-
Mark option as sourced from a
ServiceLoader. - Option.Redundant - Annotation Interface in io.helidon.builder.api
-
Mark a getter method as redundant - not important for
equals,hashcode, and/ortoString. - Option.RegistryService - Annotation Interface in io.helidon.builder.api
-
Options annotated with this annotation will use service registry to discover instances to use.
- Option.Required - Annotation Interface in io.helidon.builder.api
-
Mark option as a required option.
- Option.SameGeneric - Annotation Interface in io.helidon.builder.api
-
Useful for marking map properties, where the key and value must have the same generic type.
- Option.Singular - Annotation Interface in io.helidon.builder.api
-
Applying this annotation to a
Prototype.Blueprint-annotated interface method will cause the generated class to also include additional "add*()" methods. - Option.Type - Annotation Interface in io.helidon.builder.api
-
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.
- optionalCharArrayEquals(Optional<char[]>, Optional<char[]>) - Static method in class io.helidon.builder.api.GeneratedBuilder.EqualityUtil
-
Equals that uses
Arrays.equals(char[], char[])in case both optionals have a value. - optionalCharArrayHash(Optional<char[]>) - Static method in class io.helidon.builder.api.GeneratedBuilder.EqualityUtil
-
Hash code that uses
Arrays.hashCode(char[])in case the optional has a value.
P
- prototype() - Method in interface io.helidon.builder.api.RuntimeType.Api
-
The prototype as it was received when creating this runtime object instance.
- Prototype - Class in io.helidon.builder.api
-
Prototype is generated from a prototype blueprint, and it is expected to be part of the public API of the module.
- Prototype.Annotated - Annotation Interface in io.helidon.builder.api
-
Adding this annotation in conjunction with the
Prototype.Blueprinton a target interface type or method causes thePrototype.Annotated.value()be added to the generated implementation class and methods respectfully. - Prototype.Api - Interface in io.helidon.builder.api
-
Marker interface for the prototype API, usually a generated interface.
- Prototype.Blueprint - Annotation Interface in io.helidon.builder.api
-
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> - Interface in io.helidon.builder.api -
Terminating method of this builder that creates a prototype instance.
- Prototype.BuilderDecorator<T> - Interface in io.helidon.builder.api
-
Provides a contract by which the
Prototype.Blueprintannotated type can be decorated. - Prototype.BuilderMethod - Annotation Interface in io.helidon.builder.api
-
Annotated static method of a custom methods type to be added to builder.
- Prototype.Configured - Annotation Interface in io.helidon.builder.api
-
A blueprint annotated with this annotation will create a prototype that can be created from a
io.helidon.common.config.Configinstance. - Prototype.Constant - Annotation Interface in io.helidon.builder.api
-
Annotated constant of a custom methods type to be added to prototype interface.
- Prototype.CustomMethods - Annotation Interface in io.helidon.builder.api
-
Additional methods from this type will be added to the prototype and its builder.
- Prototype.Factory<T> - Interface in io.helidon.builder.api
-
A prototype
Prototype.Blueprintmay extend this interface to explicitly reference the associated runtime type. - Prototype.FactoryMethod - Annotation Interface in io.helidon.builder.api
-
This is an annotation used by Helidon code generator that marks a static method as a factory method.
- Prototype.Implement - Annotation Interface in io.helidon.builder.api
-
Add additional interfaces to implement by the prototype.
- Prototype.OptionDecorator<B,
T> - Interface in io.helidon.builder.api -
Provides a way to decorate a single option when it is applied to the builder.
- Prototype.PrototypeMethod - Annotation Interface in io.helidon.builder.api
-
Annotated static method of a custom methods type to be added to prototype interface.
- Prototype.Provides - Annotation Interface in io.helidon.builder.api
-
Types provided by this configured type.
- Prototype.RegistrySupport - Annotation Interface in io.helidon.builder.api
-
Generate support for Service Registry (
helidon-service-registry) for any option that is annotated asOption.Provider.
R
- root() - Element in annotation interface io.helidon.builder.api.Prototype.Configured
-
If
Prototype.Configured.value()is specified, it is considered to be a root configuration node. - RuntimeType - Class in io.helidon.builder.api
-
This class holds all types related to runtime types, configured from prototypes.
- RuntimeType.Api<T> - Interface in io.helidon.builder.api
-
This type is created from a specific prototype.
- RuntimeType.PrototypedBy - Annotation Interface in io.helidon.builder.api
-
Mark this runtime type as prototyped by a specific prototype.
S
- self() - Method in interface io.helidon.builder.api.Prototype.Builder
-
Instance of this builder as the correct type.
- stringValue() - Element in annotation interface io.helidon.builder.api.Option.Redundant
-
Set to
falseto mark this NOT redundant for toString.
T
- type() - Element in annotation interface io.helidon.builder.api.Option.DefaultMethod
-
Type to invoke the method on, defaults to the type of the property.
V
- value() - Element in annotation interface io.helidon.builder.api.Description
-
Custom description.
- value() - Element in annotation interface io.helidon.builder.api.Option.Access
-
Custom access modifier to use.
- value() - Element in annotation interface io.helidon.builder.api.Option.AllowedValue
-
Value of the option.
- value() - Element in annotation interface io.helidon.builder.api.Option.AllowedValues
-
All allowed values for this prototype option.
- value() - Element in annotation interface io.helidon.builder.api.Option.Configured
-
Override "guessed" configuration key.
- value() - Element in annotation interface io.helidon.builder.api.Option.Decorator
-
Type declaration including generic types (must match the declared generic type on the blueprint).
- value() - Element in annotation interface io.helidon.builder.api.Option.Default
-
Default value(s) to use.
- value() - Element in annotation interface io.helidon.builder.api.Option.DefaultBoolean
-
Default value(s) to use.
- value() - Element in annotation interface io.helidon.builder.api.Option.DefaultCode
-
String defining the default value.
- value() - Element in annotation interface io.helidon.builder.api.Option.DefaultDouble
-
Default value(s) to use.
- value() - Element in annotation interface io.helidon.builder.api.Option.DefaultInt
-
Default value(s) to use.
- value() - Element in annotation interface io.helidon.builder.api.Option.DefaultLong
-
Default value(s) to use.
- value() - Element in annotation interface io.helidon.builder.api.Option.DefaultMethod
-
Static method without parameters that provides the type of the property, declared on
Option.DefaultMethod.type(). - value() - Element in annotation interface io.helidon.builder.api.Option.Deprecated
-
Alternative option that replaces this option.
- value() - Element in annotation interface io.helidon.builder.api.Option.Provider
-
The service provider interface that is used to discover implementations.
- value() - Element in annotation interface io.helidon.builder.api.Option.Singular
-
The optional value specified here will determine the singular form of the method name.
- value() - Element in annotation interface io.helidon.builder.api.Option.Type
-
Type declaration including generic types (must match the declared generic type on the blueprint).
- value() - Element in annotation interface io.helidon.builder.api.Prototype.Annotated
-
The annotation(s) to add to the generated methods and field names on the generated class w/ builder.
- value() - Element in annotation interface io.helidon.builder.api.Prototype.Configured
-
Configuration node this type is read from.
- value() - Element in annotation interface io.helidon.builder.api.Prototype.CustomMethods
-
Type that implements static methods to be available on the prototype.
- value() - Element in annotation interface io.helidon.builder.api.Prototype.Implement
-
Interfaces to implement, such as
java.lang.Comparable<io.helidon.common.types.TypeName>. - value() - Element in annotation interface io.helidon.builder.api.Prototype.Provides
-
Types this type provides, probably through
ServiceLoader. - value() - Element in annotation interface io.helidon.builder.api.Prototype.RegistrySupport
-
Whether to enable (default) or disable (set to
false) registry support for this blueprint. - value() - Element in annotation interface io.helidon.builder.api.RuntimeType.PrototypedBy
-
Type of the prototype.
All Classes and Interfaces|All Packages