Class OptionInfo.Builder

java.lang.Object

io.helidon.builder.codegen.OptionInfo.BuilderBase<OptionInfo.Builder, OptionInfo>

io.helidon.builder.codegen.OptionInfo.Builder

All Implemented Interfaces:

Prototype.Builder<OptionInfo.Builder, OptionInfo>, Builder<OptionInfo.Builder, OptionInfo>, Supplier<OptionInfo>

Enclosing interface:

OptionInfo

public static class OptionInfo.Builder
extends OptionInfo.BuilderBase<OptionInfo.Builder, OptionInfo>
implements Builder<OptionInfo.Builder, OptionInfo>

Fluent API builder for OptionInfo.

Nested Class Summary

Nested classes/interfaces inherited from class OptionInfo.BuilderBase

OptionInfo.BuilderBase.OptionInfoImpl

Modifier and Type	Class	Description
protected static class	OptionInfo.BuilderBase.OptionInfoImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Method Summary

Modifier and Type	Method	Description
OptionInfo	build()	Build the instance from this builder.
OptionInfo	buildPrototype()	Create an instance of the Prototype.

Methods inherited from class OptionInfo.BuilderBase

accessModifier, accessModifier, addAllowedValue, addAllowedValue, addAllowedValues, addAnnotation, addAnnotation, addAnnotations, addInheritedAnnotation, addInheritedAnnotation, addInheritedAnnotations, addQualifier, addQualifier, addQualifiers, allowedValues, allowedValues, annotations, annotations, builderInfo, builderInfo, builderInfo, builderInfo, builderOptionOnly, builderOptionOnly, clearAllowedValues, clearAnnotations, clearBuilderInfo, clearConfigured, clearDeclaringType, clearDecorator, clearDefaultValue, clearDeprecation, clearDescription, clearInheritedAnnotations, clearInterfaceMethod, clearParamDescription, clearPrototypedBy, clearProvider, clearQualifiers, clearRuntimeType, clearSingular, confidential, confidential, configured, configured, configured, configured, declaredType, declaredType, declaredType, declaredType, declaringType, declaringType, declaringType, declaringType, decorator, decorator, decorator, decorator, defaultValue, defaultValue, deprecation, deprecation, deprecation, deprecation, description, description, from, from, getterName, getterName, includeInEqualsAndHashCode, includeInEqualsAndHashCode, includeInToString, includeInToString, inheritedAnnotations, inheritedAnnotations, interfaceMethod, interfaceMethod, interfaceMethod, interfaceMethod, name, name, paramDescription, paramDescription, preBuildPrototype, prototypedBy, prototypedBy, prototypedBy, prototypedBy, provider, provider, provider, provider, qualifiers, qualifiers, registryService, registryService, required, required, runtimeType, runtimeType, runtimeType, runtimeType, sameGeneric, sameGeneric, setterName, setterName, singular, singular, singular, singular, toString, validatePrototype

Modifier and Type	Method	Description
AccessModifier	accessModifier()	Access modifier of generated setter methods on builder.
OptionInfo.Builder	accessModifier(AccessModifier accessModifier)	Access modifier of generated setter methods on builder.
OptionInfo.Builder	addAllowedValue(OptionAllowedValue allowedValue)	List of allowed values for this option.
OptionInfo.Builder	addAllowedValue(Consumer<OptionAllowedValue.Builder> consumer)	List of allowed values for this option.
OptionInfo.Builder	addAllowedValues(List<? extends OptionAllowedValue> allowedValues)	List of allowed values for this option.
OptionInfo.Builder	addAnnotation(Annotation annotation)	Annotations option.
OptionInfo.Builder	addAnnotation(Consumer<Annotation.Builder> consumer)	Annotations option.
OptionInfo.Builder	addAnnotations(List<? extends Annotation> annotations)	Annotations option.
OptionInfo.Builder	addInheritedAnnotation(Annotation inheritedAnnotation)	InheritedAnnotations option.
OptionInfo.Builder	addInheritedAnnotation(Consumer<Annotation.Builder> consumer)	InheritedAnnotations option.
OptionInfo.Builder	addInheritedAnnotations(List<? extends Annotation> inheritedAnnotations)	InheritedAnnotations option.
OptionInfo.Builder	addQualifier(Annotation qualifier)	List of qualifiers for this option.
OptionInfo.Builder	addQualifier(Consumer<Annotation.Builder> consumer)	List of qualifiers for this option.
OptionInfo.Builder	addQualifiers(List<? extends Annotation> qualifiers)	List of qualifiers for this option.
List<OptionAllowedValue>	allowedValues()	List of allowed values for this option.
OptionInfo.Builder	allowedValues(List<? extends OptionAllowedValue> allowedValues)	List of allowed values for this option.
List<Annotation>	annotations()	Annotations option.
OptionInfo.Builder	annotations(List<? extends Annotation> annotations)	Annotations option.
Optional<OptionBuilder>	builderInfo()	If the option has a builder, return its information.
OptionInfo.Builder	builderInfo(OptionBuilder builderInfo)	If the option has a builder, return its information.
OptionInfo.Builder	builderInfo(Consumer<OptionBuilder.Builder> consumer)	If the option has a builder, return its information.
OptionInfo.Builder	builderInfo(Supplier<? extends OptionBuilder> supplier)	If the option has a builder, return its information.
boolean	builderOptionOnly()	Set to true if this option is only available on the builder.
OptionInfo.Builder	builderOptionOnly(boolean builderOptionOnly)	Set to true if this option is only available on the builder.
OptionInfo.Builder	clearAllowedValues()	Clear all allowedValues.
OptionInfo.Builder	clearAnnotations()	Clear all annotations.
OptionInfo.Builder	clearBuilderInfo()	Clear existing value of builderInfo.
OptionInfo.Builder	clearConfigured()	Clear existing value of configured.
OptionInfo.Builder	clearDeclaringType()	Clear existing value of declaringType.
OptionInfo.Builder	clearDecorator()	Clear existing value of decorator.
OptionInfo.Builder	clearDefaultValue()	Clear existing value of defaultValue.
OptionInfo.Builder	clearDeprecation()	Clear existing value of deprecation.
OptionInfo.Builder	clearDescription()	Clear existing value of description.
OptionInfo.Builder	clearInheritedAnnotations()	Clear all inheritedAnnotations.
OptionInfo.Builder	clearInterfaceMethod()	Clear existing value of interfaceMethod.
OptionInfo.Builder	clearParamDescription()	Clear existing value of paramDescription.
OptionInfo.Builder	clearPrototypedBy()	Clear existing value of prototypedBy.
OptionInfo.Builder	clearProvider()	Clear existing value of provider.
OptionInfo.Builder	clearQualifiers()	Clear all qualifiers.
OptionInfo.Builder	clearRuntimeType()	Clear existing value of runtimeType.
OptionInfo.Builder	clearSingular()	Clear existing value of singular.
boolean	confidential()	Whether this option is confidential (i.e.
OptionInfo.Builder	confidential(boolean confidential)	Whether this option is confidential (i.e.
Optional<OptionConfigured>	configured()	Details about configurability of this option.
OptionInfo.Builder	configured(OptionConfigured configured)	Details about configurability of this option.
OptionInfo.Builder	configured(Consumer<OptionConfigured.Builder> consumer)	Details about configurability of this option.
OptionInfo.Builder	configured(Supplier<? extends OptionConfigured> supplier)	Details about configurability of this option.
Optional<TypeName>	declaredType()	The return type of the blueprint method, or the type expected in getter of the option.
OptionInfo.Builder	declaredType(TypeName declaredType)	The return type of the blueprint method, or the type expected in getter of the option.
OptionInfo.Builder	declaredType(Consumer<TypeName.Builder> consumer)	The return type of the blueprint method, or the type expected in getter of the option.
OptionInfo.Builder	declaredType(Supplier<? extends TypeName> supplier)	The return type of the blueprint method, or the type expected in getter of the option.
Optional<TypeInfo>	declaringType()	Type that declares this option.
OptionInfo.Builder	declaringType(TypeInfo declaringType)	Type that declares this option.
OptionInfo.Builder	declaringType(Consumer<TypeInfo.Builder> consumer)	Type that declares this option.
OptionInfo.Builder	declaringType(Supplier<? extends TypeInfo> supplier)	Type that declares this option.
Optional<TypeName>	decorator()	Option decorator type.
OptionInfo.Builder	decorator(TypeName decorator)	Option decorator type.
OptionInfo.Builder	decorator(Consumer<TypeName.Builder> consumer)	Option decorator type.
OptionInfo.Builder	decorator(Supplier<? extends TypeName> supplier)	Option decorator type.
Optional<Consumer<ContentBuilder<?>>>	defaultValue()	Default value for this option, a consumer of the field content builder.
OptionInfo.Builder	defaultValue(Consumer<ContentBuilder<?>> defaultValue)	Default value for this option, a consumer of the field content builder.
Optional<OptionDeprecation>	deprecation()	Deprecation details.
OptionInfo.Builder	deprecation(OptionDeprecation deprecation)	Deprecation details.
OptionInfo.Builder	deprecation(Consumer<OptionDeprecation.Builder> consumer)	Deprecation details.
OptionInfo.Builder	deprecation(Supplier<? extends OptionDeprecation> supplier)	Deprecation details.
Optional<String>	description()	Description of this option, used in Javadoc as the main text if defined.
OptionInfo.Builder	description(String description)	Description of this option, used in Javadoc as the main text if defined.
OptionInfo.Builder	from(OptionInfo prototype)	Update this builder from an existing prototype instance.
OptionInfo.Builder	from(OptionInfo.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<String>	getterName()	Name of the getter methods.
OptionInfo.Builder	getterName(String getterName)	Name of the getter methods.
boolean	includeInEqualsAndHashCode()	Whether to include this option in generated Object.equals(Object) and Object.hashCode() methods.
OptionInfo.Builder	includeInEqualsAndHashCode(boolean includeInEqualsAndHashCode)	Whether to include this option in generated Object.equals(Object) and Object.hashCode() methods.
boolean	includeInToString()	Whether to include this option in generated Object.toString() method.
OptionInfo.Builder	includeInToString(boolean includeInToString)	Whether to include this option in generated Object.toString() method.
List<Annotation>	inheritedAnnotations()	InheritedAnnotations option.
OptionInfo.Builder	inheritedAnnotations(List<? extends Annotation> inheritedAnnotations)	InheritedAnnotations option.
Optional<TypedElementInfo>	interfaceMethod()	Blueprint method if created from blueprint, or interface method if inherited from non-blueprint interface.
OptionInfo.Builder	interfaceMethod(TypedElementInfo interfaceMethod)	Blueprint method if created from blueprint, or interface method if inherited from non-blueprint interface.
OptionInfo.Builder	interfaceMethod(Consumer<TypedElementInfo.Builder> consumer)	Blueprint method if created from blueprint, or interface method if inherited from non-blueprint interface.
OptionInfo.Builder	interfaceMethod(Supplier<? extends TypedElementInfo> supplier)	Blueprint method if created from blueprint, or interface method if inherited from non-blueprint interface.
Optional<String>	name()	Option name.
OptionInfo.Builder	name(String name)	Option name.
Optional<String>	paramDescription()	Parameter/return type description, used in Javadoc as the param/return description.
OptionInfo.Builder	paramDescription(String paramDescription)	Parameter/return type description, used in Javadoc as the param/return description.
protected void	preBuildPrototype()	Handles providers and decorators.
Optional<TypeName>	prototypedBy()	A prototype that can build this option type.
OptionInfo.Builder	prototypedBy(TypeName prototypedBy)	A prototype that can build this option type.
OptionInfo.Builder	prototypedBy(Consumer<TypeName.Builder> consumer)	A prototype that can build this option type.
OptionInfo.Builder	prototypedBy(Supplier<? extends TypeName> supplier)	A prototype that can build this option type.
Optional<OptionProvider>	provider()	Provider details.
OptionInfo.Builder	provider(OptionProvider provider)	Provider details.
OptionInfo.Builder	provider(Consumer<OptionProvider.Builder> consumer)	Provider details.
OptionInfo.Builder	provider(Supplier<? extends OptionProvider> supplier)	Provider details.
List<Annotation>	qualifiers()	List of qualifiers for this option.
OptionInfo.Builder	qualifiers(List<? extends Annotation> qualifiers)	List of qualifiers for this option.
boolean	registryService()	Whether this option should be loaded from ServiceRegistry.
OptionInfo.Builder	registryService(boolean registryService)	Whether this option should be loaded from ServiceRegistry.
boolean	required()	Whether this is a required option.
OptionInfo.Builder	required(boolean required)	Whether this is a required option.
Optional<RuntimeTypeInfo>	runtimeType()	Custom runtime type factory method.
OptionInfo.Builder	runtimeType(RuntimeTypeInfo runtimeType)	Custom runtime type factory method.
OptionInfo.Builder	runtimeType(Consumer<RuntimeTypeInfo.Builder> consumer)	Custom runtime type factory method.
OptionInfo.Builder	runtimeType(Supplier<? extends RuntimeTypeInfo> supplier)	Custom runtime type factory method.
boolean	sameGeneric()	Whether this Map option is expected to have the same generic type for key and value.
OptionInfo.Builder	sameGeneric(boolean sameGeneric)	Whether this Map option is expected to have the same generic type for key and value.
Optional<String>	setterName()	Name of the setter method(s).
OptionInfo.Builder	setterName(String setterName)	Name of the setter method(s).
Optional<OptionSingular>	singular()	Singular option details.
OptionInfo.Builder	singular(OptionSingular singular)	Singular option details.
OptionInfo.Builder	singular(Consumer<OptionSingular.Builder> consumer)	Singular option details.
OptionInfo.Builder	singular(Supplier<? extends OptionSingular> supplier)	Singular option details.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default OptionInfo	get()
default OptionInfo.Builder	identity()	Instance of this builder as the correct type.
default OptionInfo.Builder	update(Consumer<OptionInfo.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default OptionInfo.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public OptionInfo buildPrototype()

Description copied from interface: Prototype.Builder

Create an instance of the Prototype. This method is available on all generated builders for Prototype.Blueprint.

Calling this method may update the builder from providers and decorators, so repeated calls may have side effects such as repeated provider discovery.

Specified by:

buildPrototype in interface Prototype.Builder<OptionInfo.Builder, OptionInfo>

Returns:

an instance of the setup object created from this builder

build

public OptionInfo build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OptionInfo.Builder, OptionInfo>

Returns:

instance of the built type