Module io.helidon.builder.codegen

Package io.helidon.builder.codegen

Interface FactoryMethod

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

FactoryMethod.BuilderBase.FactoryMethodImpl

public interface FactoryMethod
extends Prototype.Api

Some static methods on custom methods (and deprecated option on the blueprint itself) may be annotated with Prototype.FactoryMethod.

Such methods can be used to map from configuration to a type, or from a prototype to a third party runtime-type.

See Also:

• builder()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FactoryMethod.Builder	builder()	Create a new fluent API builder to customize configuration.
static FactoryMethod.Builder	builder(FactoryMethod instance)	Create a new fluent API builder from an existing instance.
TypeName	declaringType()	Type declaring the factory method.
String	methodName()	Name of the factory method.
Optional<String>	optionName()	A factory method may be bound to a specific option.
Optional<TypeName>	parameterType()	A parameter of the factory method, if any.
TypeName	returnType()	Return type of the factory method.

Method Details

builder

static FactoryMethod.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static FactoryMethod.Builder builder(FactoryMethod 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

declaringType

TypeName declaringType()

Type declaring the factory method.

Returns:

type declaring the factory method

returnType

TypeName returnType()

Return type of the factory method.

Returns:

return type of the factory method

methodName

String methodName()

Name of the factory method.

Returns:

factory method name

parameterType

Optional<TypeName> parameterType()

A parameter of the factory method, if any.

Returns:

parameter type, if any

optionName

Optional<String> optionName()

A factory method may be bound to a specific option.

Returns:

name of the option this factory method is bound to, if any