Module io.helidon.pico.tools

Package io.helidon.pico.tools

Class DefaultActivatorCreator

java.lang.Object

io.helidon.pico.tools.AbstractCreator

io.helidon.pico.tools.DefaultActivatorCreator

All Implemented Interfaces:

Weighted, ActivatorCreator, Comparable<Weighted>

@Singleton
public class DefaultActivatorCreator
extends AbstractCreator
implements ActivatorCreator, Weighted

Responsible for building all pico-di related collateral for a module, including:

1. The ServiceProvider for each service type implementation passed in.
2. The Activator and DeActivator for each service type implementation passed in.
3. The Module for the aggregate service provider bindings for the same set of service type names.
4. The module-info as appropriate for the above set of services (and contracts).
5. The /META-INF/services entries as appropriate.

This API can also be used to only produce meta-information describing the model without the codegen option - see GeneralCreatorRequest.codeGenPaths() for details.

Field Summary

Fields inherited from class io.helidon.pico.tools.AbstractCreator

DEFAULT_SOURCE, DEFAULT_TARGET

Fields inherited from interface io.helidon.common.Weighted

DEFAULT_WEIGHT

Constructor Summary

Constructors

Constructor	Description
DefaultActivatorCreator()	Deprecated. this is a Java ServiceLoader implementation and the constructor should not be used directly

Method Summary

Modifier and Type	Method	Description
InterceptorCreatorResponse	codegenInterceptors(GeneralCreatorRequest req, Map<TypeName,InterceptionPlan> interceptionPlans)	Generates just the interceptors.
static Optional<ActivatorCreatorCodeGen>	createActivatorCreatorCodeGen(ServicesToProcess services)	Creates a payload given the batch of services to process.
static ActivatorCreatorRequest	createActivatorCreatorRequest(ServicesToProcess servicesToProcess, ActivatorCreatorCodeGen codeGen, ActivatorCreatorConfigOptions configOptions, CodeGenFiler filer, boolean throwIfError)	Create a request based upon the contents of services to processor.
ActivatorCreatorResponse	createModuleActivators(ActivatorCreatorRequest req)	Used during annotation processing in compile time to automatically generate Activator's and optionally an aggregating Module for those activators.
TypeName	toActivatorImplTypeName(TypeName serviceTypeName)	Generates the would-be implementation type name that will be generated if ActivatorCreator.createModuleActivators(ActivatorCreatorRequest) were to be called on this creator.
static ServiceInfoBasics	toServiceInfo(TypeName serviceTypeName, ActivatorCreatorCodeGen codeGen)	Creates service info from the service type name and the activator create codegen request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Weighted

compareTo, weight

Constructor Details

DefaultActivatorCreator

@Deprecated
public DefaultActivatorCreator()

Deprecated.

this is a Java ServiceLoader implementation and the constructor should not be used directly

Service loader based constructor.

Method Details

createModuleActivators

public ActivatorCreatorResponse createModuleActivators(ActivatorCreatorRequest req)
                                                throws ToolsException

Description copied from interface: ActivatorCreator

Used during annotation processing in compile time to automatically generate Activator's and optionally an aggregating Module for those activators.

Specified by:

createModuleActivators in interface ActivatorCreator

Parameters:

req - the request for what to generate

Returns:

the response result for the create operation

Throws:

ToolsException

codegenInterceptors

public InterceptorCreatorResponse codegenInterceptors(GeneralCreatorRequest req,
 Map<TypeName,InterceptionPlan> interceptionPlans)

Description copied from interface: ActivatorCreator

Generates just the interceptors.

Specified by:

codegenInterceptors in interface ActivatorCreator

Parameters:

req - the request for what to generate

interceptionPlans - the interceptor plans

Returns:

the response result for the create operation

createActivatorCreatorCodeGen

public static Optional<ActivatorCreatorCodeGen> createActivatorCreatorCodeGen(ServicesToProcess services)

Creates a payload given the batch of services to process.

Parameters:

services - the services to process

Returns:

the payload, or empty if unable or nothing to process

createActivatorCreatorRequest

public static ActivatorCreatorRequest createActivatorCreatorRequest(ServicesToProcess servicesToProcess,
 ActivatorCreatorCodeGen codeGen,
 ActivatorCreatorConfigOptions configOptions,
 CodeGenFiler filer,
 boolean throwIfError)

Create a request based upon the contents of services to processor.

Parameters:

servicesToProcess - the batch being processed

codeGen - the code gen request

configOptions - the config options

filer - the filer

throwIfError - fail on error?

Returns:

the activator request instance

toActivatorImplTypeName

public TypeName toActivatorImplTypeName(TypeName serviceTypeName)

Description copied from interface: ActivatorCreator

Generates the would-be implementation type name that will be generated if ActivatorCreator.createModuleActivators(ActivatorCreatorRequest) were to be called on this creator.

Specified by:

toActivatorImplTypeName in interface ActivatorCreator

Parameters:

serviceTypeName - the service/activator type name of the developer provided service type.

Returns:

the code generated implementation type name that would be code generated

toServiceInfo

public static ServiceInfoBasics toServiceInfo(TypeName serviceTypeName,
 ActivatorCreatorCodeGen codeGen)

Creates service info from the service type name and the activator create codegen request.

Parameters:

serviceTypeName - the service type name

codeGen - the code gen request

Returns:

the service info