Package io.micronaut.starter.application.generator

Class GeneratorContext

java.lang.Object

io.micronaut.starter.application.generator.GeneratorContext

All Implemented Interfaces:

DependencyContext

public class GeneratorContext
extends Object
implements DependencyContext

A context object used when generating projects.

Since:

1.0.0

Author:

graemerocher

Field Summary

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

IS_COMPILE_API_OR_RUNTIME

Constructor Summary

Constructors

Constructor	Description
GeneratorContext(Project project, ApplicationType type, Options options, @Nullable OperatingSystem operatingSystem, Set<Feature> features, CoordinateResolver coordinateResolver)

Method Summary

Modifier and Type	Method	Description
void	addBuildPlugin(BuildPlugin buildPlugin)
void	addConfiguration(@NonNull Configuration configuration)
void	addDependency(@NonNull Dependency dependency)
void	addHelpLink(String label, 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(@NonNull Profile profile)
void	addTemplate(String name, Template template)	Adds a template.
void	addTemplate(String templateName, String triggerFile, com.fizzed.rocker.RockerModel javaTemplate, com.fizzed.rocker.RockerModel kotlinTemplate, com.fizzed.rocker.RockerModel groovyTemplate)
void	addTemplate(String name, String path, TestRockerModelProvider testRockerModelProvider)
void	applyFeatures()
long	countDependencies(@NonNull String groupId)
@NonNull Map<String,Object>	getAdditionalOptions()
@NonNull Set<Configuration>	getAllConfigurations()
@NonNull ApplicationType	getApplicationType()
@NonNull BootstrapConfiguration	getBootstrapConfiguration()
@Nullable BootstrapConfiguration	getBootstrapConfiguration(String env)
@NonNull BootstrapConfiguration	getBootstrapConfiguration(String env, BootstrapConfiguration defaultConfig)
Set<BuildPlugin>	getBuildPlugins()
@NonNull BuildProperties	getBuildProperties()
@NonNull BuildTool	getBuildTool()
@NonNull ApplicationConfiguration	getConfiguration()
@Nullable ApplicationConfiguration	getConfiguration(String env)
@NonNull ApplicationConfiguration	getConfiguration(String env, ApplicationConfiguration defaultConfig)
@NonNull Collection<Dependency>	getDependencies()
<T extends Feature> Optional<T>	getFeature(Class<T> feature)
@NonNull Features	getFeatures()
@NonNull String	getFramework()
@NonNull List<Writable>	getHelpTemplates()
@NonNull JdkVersion	getJdkVersion()
@NonNull Language	getLanguage()
Collection<String>	getModuleNames()
@Nullable OperatingSystem	getOperatingSystem()
@NonNull Collection<Profile>	getProfiles()
@NonNull Project	getProject()
<T extends Feature> T	getRequiredFeature(Class<T> feature)
String	getSourcePath(String path)
@NonNull Map<String,Template>	getTemplates()
@NonNull TestFramework	getTestFramework()
String	getTestSourcePath(String path)
boolean	hasConfigurationEnvironment(@NonNull String env)
boolean	hasDependency(@NonNull String groupId, @NonNull String artifactId)
boolean	hasDependencyInScope(@NonNull String groupId, @NonNull String artifactId, @NonNull Scope scope)
<T extends Feature> boolean	hasFeature(Class<T> featureClass)
boolean	isFeatureMissing(Class<? extends Feature> feature)
boolean	isFeaturePresent(Class<? extends Feature> feature)
boolean	isMicronautFramework()
protected com.fizzed.rocker.RockerModel	parseModel(com.fizzed.rocker.RockerModel javaTemplate, com.fizzed.rocker.RockerModel kotlinTemplate, com.fizzed.rocker.RockerModel groovyTemplate)
void	removeTemplate(String name)	Adds a template.
Coordinate	resolveCoordinate(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, removeDuplicates

Constructor Details

GeneratorContext

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

Method Details

addTemplate

public void addTemplate(String name,
 Template template)

Adds a template.

Parameters:

name - The name of the template

template - The template

removeTemplate

public void removeTemplate(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(String label,
 String href)

Ads a Link to a single help file

Parameters:

label - Link's label

href - Link's uri

getBuildProperties

@NonNull
public @NonNull BuildProperties getBuildProperties()

Returns:

The build properties

getConfiguration

@NonNull
public @NonNull ApplicationConfiguration getConfiguration()

Returns:

The configuration

getConfiguration

@Nullable
public @Nullable ApplicationConfiguration getConfiguration(String env)

Parameters:

env - Environment

Returns:

The configuration

hasConfigurationEnvironment

public boolean hasConfigurationEnvironment(@NonNull
 @NonNull String env)

getConfiguration

@NonNull
public @NonNull ApplicationConfiguration getConfiguration(String env,
 ApplicationConfiguration defaultConfig)

Parameters:

env - Environment

defaultConfig - Default Configuration

Returns:

Application Configuration

getBootstrapConfiguration

@Nullable
public @Nullable BootstrapConfiguration getBootstrapConfiguration(String env)

Parameters:

env - Environment

Returns:

The configuration

getBootstrapConfiguration

@NonNull
public @NonNull BootstrapConfiguration getBootstrapConfiguration(String env,
 BootstrapConfiguration defaultConfig)

getBootstrapConfiguration

@NonNull
public @NonNull BootstrapConfiguration getBootstrapConfiguration()

Returns:

The bootstrap config

addConfiguration

public void addConfiguration(@NonNull
 @NonNull Configuration configuration)

getAllConfigurations

@NonNull
public @NonNull Set<Configuration> getAllConfigurations()

getTemplates

@NonNull
public @NonNull Map<String,Template> getTemplates()

Returns:

The templates

getHelpTemplates

@NonNull
public @NonNull List<Writable> getHelpTemplates()

Returns:

The templates

getLanguage

@NonNull
public @NonNull Language getLanguage()

Returns:

The language

getTestFramework

@NonNull
public @NonNull TestFramework getTestFramework()

Returns:

The test framework

getFramework

@NonNull
public @NonNull String getFramework()

Returns:

The framework

getBuildTool

@NonNull
public @NonNull BuildTool getBuildTool()

Returns:

The build tool

getAdditionalOptions

@NonNull
public @NonNull Map<String,Object> getAdditionalOptions()

Returns:

A map containing additional options

getProject

@NonNull
public @NonNull Project getProject()

Returns:

The project

getApplicationType

@NonNull
public @NonNull ApplicationType getApplicationType()

Returns:

The application type

getFeatures

@NonNull
public @NonNull Features getFeatures()

Returns:

The selected features

getJdkVersion

@NonNull
public @NonNull JdkVersion getJdkVersion()

Returns:

The JDK version

getOperatingSystem

@Nullable
public @Nullable OperatingSystem getOperatingSystem()

Returns:

The current OS

applyFeatures

public void applyFeatures()

isFeaturePresent

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

isFeatureMissing

public boolean isFeatureMissing(Class<? extends Feature> feature)

getFeature

public <T extends Feature> Optional<T> getFeature(Class<T> feature)

getRequiredFeature

public <T extends Feature> T getRequiredFeature(Class<T> feature)

getSourcePath

public String getSourcePath(String path)

getTestSourcePath

public String getTestSourcePath(String path)

parseModel

protected com.fizzed.rocker.RockerModel parseModel(com.fizzed.rocker.RockerModel javaTemplate,
 com.fizzed.rocker.RockerModel kotlinTemplate,
 com.fizzed.rocker.RockerModel groovyTemplate)

addTemplate

public void addTemplate(String name,
 String path,
 TestRockerModelProvider testRockerModelProvider)

addTemplate

public void addTemplate(String templateName,
 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(String artifactId)

addDependency

public void addDependency(@NonNull
 @NonNull Dependency dependency)

Specified by:

addDependency in interface DependencyContext

getDependencies

@NonNull
public @NonNull Collection<Dependency> getDependencies()

Specified by:

getDependencies in interface DependencyContext

getBuildPlugins

public Set<BuildPlugin> getBuildPlugins()

getModuleNames

public Collection<String> getModuleNames()

addProfile

public void addProfile(@NonNull
 @NonNull Profile profile)

getProfiles

@NonNull
public @NonNull Collection<Profile> getProfiles()

hasFeature

public <T extends Feature> boolean hasFeature(Class<T> featureClass)

isMicronautFramework

public boolean isMicronautFramework()

hasDependencyInScope

public boolean hasDependencyInScope(@NonNull
 @NonNull String groupId,
 @NonNull
 @NonNull String artifactId,
 @NonNull
 @NonNull Scope scope)

hasDependency

public boolean hasDependency(@NonNull
 @NonNull String groupId,
 @NonNull
 @NonNull String artifactId)

countDependencies

public long countDependencies(@NonNull
 @NonNull String groupId)