io.micronaut.starter.application.generator

Class GeneratorContext

java.lang.Object

io.micronaut.starter.application.generator.GeneratorContext

All Implemented Interfaces:

DependencyContext

public class GeneratorContext
extends java.lang.Object
implements DependencyContext

A context object used when generating projects.

Since:

1.0.0

Author:

graemerocher

Constructor Summary

Constructors

Constructor and Description
GeneratorContext(Project project, ApplicationType type, Options options, OperatingSystem operatingSystem, java.util.Set<Feature> features, CoordinateResolver coordinateResolver)

Method Summary

Modifier and Type	Method and Description
void	addBuildPlugin(BuildPlugin buildPlugin)
void	addConfiguration(Configuration configuration)
void	addDependency(Dependency dependency)
void	addHelpLink(java.lang.String label, java.lang.String href) Ads a Link to a single help file
void	addHelpTemplate(Writable writable) Adds a template which will be consolidated into a single help file.
void	addProfile(Profile profile)
void	addTemplate(java.lang.String templateName, java.lang.String triggerFile, com.fizzed.rocker.RockerModel javaTemplate, com.fizzed.rocker.RockerModel kotlinTemplate, com.fizzed.rocker.RockerModel groovyTemplate)
void	addTemplate(java.lang.String name, java.lang.String path, TestRockerModelProvider testRockerModelProvider)
void	addTemplate(java.lang.String name, Template template) Adds a template.
void	applyFeatures()
java.util.Set<Configuration>	getAllConfigurations()
ApplicationType	getApplicationType()
BootstrapConfiguration	getBootstrapConfiguration()
BootstrapConfiguration	getBootstrapConfiguration(java.lang.String env)
BootstrapConfiguration	getBootstrapConfiguration(java.lang.String env, BootstrapConfiguration defaultConfig)
java.util.Set<BuildPlugin>	getBuildPlugins()
BuildProperties	getBuildProperties()
BuildTool	getBuildTool()
ApplicationConfiguration	getConfiguration()
ApplicationConfiguration	getConfiguration(java.lang.String env)
ApplicationConfiguration	getConfiguration(java.lang.String env, ApplicationConfiguration defaultConfig)
java.util.Collection<Dependency>	getDependencies()
<T extends Feature> java.util.Optional<T>	getFeature(java.lang.Class<T> feature)
Features	getFeatures()
java.util.List<Writable>	getHelpTemplates()
JdkVersion	getJdkVersion()
Language	getLanguage()
java.util.Collection<java.lang.String>	getModuleNames()
OperatingSystem	getOperatingSystem()
java.util.Collection<Profile>	getProfiles()
Project	getProject()
<T extends Feature> T	getRequiredFeature(java.lang.Class<T> feature)
java.lang.String	getSourcePath(java.lang.String path)
java.util.Map<java.lang.String,Template>	getTemplates()
TestFramework	getTestFramework()
java.lang.String	getTestSourcePath(java.lang.String path)
boolean	hasConfigurationEnvironment(java.lang.String env)
boolean	isFeaturePresent(java.lang.Class<? extends Feature> feature)
void	removeTemplate(java.lang.String name) Adds a template.
Coordinate	resolveCoordinate(java.lang.String artifactId)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.starter.build.dependencies.DependencyContext

addDependency

Constructor Detail

GeneratorContext

public GeneratorContext(Project project,
                        ApplicationType type,
                        Options options,
                        @Nullable
                        OperatingSystem operatingSystem,
                        java.util.Set<Feature> features,
                        CoordinateResolver coordinateResolver)

Method Detail

addTemplate

public void addTemplate(java.lang.String name,
                        Template template)

Adds a template.

Parameters:

name - The name of the template

template - The template

removeTemplate

public void removeTemplate(java.lang.String name)

Adds a template.

Parameters:

name - The name of the template

addHelpTemplate

public void addHelpTemplate(Writable writable)

Adds a template which will be consolidated into a single help file.

Parameters:

writable - The template

addHelpLink

public void addHelpLink(java.lang.String label,
                        java.lang.String href)

Ads a Link to a single help file

Parameters:

label - Link's label

href - Link's uri

getBuildProperties

@NonNull
public BuildProperties getBuildProperties()

Returns:

The build properties

getConfiguration

@NonNull
public ApplicationConfiguration getConfiguration()

Returns:

The configuration

getConfiguration

@Nullable
public ApplicationConfiguration getConfiguration(java.lang.String env)

Parameters:

env - Environment

Returns:

The configuration

hasConfigurationEnvironment

public boolean hasConfigurationEnvironment(@NonNull
                                           java.lang.String env)

getConfiguration

@NonNull
public ApplicationConfiguration getConfiguration(java.lang.String env,
                                                          ApplicationConfiguration defaultConfig)

Parameters:

env - Environment

defaultConfig - Default Configuration

Returns:

Application Configuration

getBootstrapConfiguration

@Nullable
public BootstrapConfiguration getBootstrapConfiguration(java.lang.String env)

Parameters:

env - Environment

Returns:

The configuration

getBootstrapConfiguration

@NonNull
public BootstrapConfiguration getBootstrapConfiguration(java.lang.String env,
                                                                 BootstrapConfiguration defaultConfig)

getBootstrapConfiguration

@NonNull
public BootstrapConfiguration getBootstrapConfiguration()

Returns:

The bootstrap config

addConfiguration

public void addConfiguration(@NonNull
                             Configuration configuration)

getAllConfigurations

@NonNull
public java.util.Set<Configuration> getAllConfigurations()

getTemplates

@NonNull
public java.util.Map<java.lang.String,Template> getTemplates()

Returns:

The templates

getHelpTemplates

@NonNull
public java.util.List<Writable> getHelpTemplates()

Returns:

The templates

getLanguage

@NonNull
public Language getLanguage()

Returns:

The language

getTestFramework

@NonNull
public TestFramework getTestFramework()

Returns:

The test framework

getBuildTool

@NonNull
public BuildTool getBuildTool()

Returns:

The build tool

getProject

@NonNull
public Project getProject()

Returns:

The project

getApplicationType

@NonNull
public ApplicationType getApplicationType()

Returns:

The application type

getFeatures

@NonNull
public Features getFeatures()

Returns:

The selected features

getJdkVersion

@NonNull
public JdkVersion getJdkVersion()

Returns:

The JDK version

getOperatingSystem

@Nullable
public OperatingSystem getOperatingSystem()

Returns:

The current OS

applyFeatures

public void applyFeatures()

isFeaturePresent

public boolean isFeaturePresent(java.lang.Class<? extends Feature> feature)

getFeature

public <T extends Feature> java.util.Optional<T> getFeature(java.lang.Class<T> feature)

getRequiredFeature

public <T extends Feature> T getRequiredFeature(java.lang.Class<T> feature)

getSourcePath

public java.lang.String getSourcePath(java.lang.String path)

getTestSourcePath

public java.lang.String getTestSourcePath(java.lang.String path)

addTemplate

public void addTemplate(java.lang.String name,
                        java.lang.String path,
                        TestRockerModelProvider testRockerModelProvider)

addTemplate

public void addTemplate(java.lang.String templateName,
                        java.lang.String triggerFile,
                        com.fizzed.rocker.RockerModel javaTemplate,
                        com.fizzed.rocker.RockerModel kotlinTemplate,
                        com.fizzed.rocker.RockerModel groovyTemplate)

addBuildPlugin

public void addBuildPlugin(BuildPlugin buildPlugin)

resolveCoordinate

public Coordinate resolveCoordinate(java.lang.String artifactId)

addDependency

public void addDependency(@NonNull
                          Dependency dependency)

Specified by:

addDependency in interface DependencyContext

getDependencies

@NonNull
public java.util.Collection<Dependency> getDependencies()

Specified by:

getDependencies in interface DependencyContext

getBuildPlugins

public java.util.Set<BuildPlugin> getBuildPlugins()

getModuleNames

public java.util.Collection<java.lang.String> getModuleNames()

addProfile

public void addProfile(@NonNull
                       Profile profile)

getProfiles

@NonNull
public java.util.Collection<Profile> getProfiles()