Package io.micronaut.projectgen.core.generator

Class GeneratorContext

java.lang.Object

io.micronaut.projectgen.core.generator.GeneratorContext

public class GeneratorContext
extends Object

A context object used when generating projects.

Since:

1.0.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROOT_PROJECT

Constructor Summary

Constructors

Constructor	Description
GeneratorContext(Project project, Options options, Set<Feature> features, CoordinateResolver coordinateResolver, RecipeFetcher recipeFetcher)

Method Summary

Modifier and Type	Method	Description
void	applyFeatures()	Apply features.
Optional<String>	findFrameworkDocumentationByRecipeName(@NonNull String recipeName)
Optional<String>	findThirdPartyDocumentationByRecipeName(@NonNull String recipeName)
@NonNull BuildTool	getBuildTool()	Deprecated, for removal: This API element is subject to removal in a future version.
<T extends Feature> Optional<T>	getFeature(Class<T> feature)
@NonNull Features	getFeatures()
@NonNull JdkVersion	getJdkVersion()
@NonNull Language	getLanguage()
ModuleContext	getModuleByName(String name)
Collection<String>	getModuleNames()
@NonNull Options	getOptions()
@NonNull Project	getProject()
<T extends Feature> T	getRequiredFeature(Class<T> feature)
ModuleContext	getRootModule()
String	getSourcePath(String path)
@NonNull TestFramework	getTestFramework()
String	getTestSourcePath(String path)
<T extends Feature> boolean	hasFeature(Class<T> featureClass)
boolean	isFeatureMissing(Class<? extends Feature> feature)
boolean	isFeaturePresent(Class<? extends Feature> feature)
Coordinate	resolveCoordinate(String artifactId)

Methods inherited from class java.lang.Object

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

Field Details

ROOT_PROJECT

public static final String ROOT_PROJECT

See Also:

• Constant Field Values

Constructor Details

GeneratorContext

public GeneratorContext(Project project,
 Options options,
 Set<Feature> features,
 CoordinateResolver coordinateResolver,
 RecipeFetcher recipeFetcher)

Method Details

getRootModule

public ModuleContext getRootModule()

Returns:

Root Module

getModuleByName

public ModuleContext getModuleByName(String name)

Parameters:

name - Module Name

Returns:

A Module

getLanguage

@NonNull
public @NonNull Language getLanguage()

Returns:

The language

getOptions

@NonNull
public @NonNull Options getOptions()

Returns:

Options

getBuildTool

@Deprecated(forRemoval=true)
@NonNull
public @NonNull BuildTool getBuildTool()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns:

The test framework

getTestFramework

@NonNull
public @NonNull TestFramework getTestFramework()

Returns:

The test framework

getProject

@NonNull
public @NonNull Project getProject()

Returns:

The project

getFeatures

@NonNull
public @NonNull Features getFeatures()

Returns:

The selected features

getJdkVersion

@NonNull
public @NonNull JdkVersion getJdkVersion()

Returns:

The JDK version

applyFeatures

public void applyFeatures()

Apply features.

isFeaturePresent

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

Parameters:

feature - Feature is present

Returns:

Whether the feature is present

isFeatureMissing

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

Parameters:

feature - Feature is present

Returns:

Whether the feature is missing

getFeature

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

Type Parameters:

T - feature Type

Parameters:

feature - Feature is present

Returns:

the feature

getRequiredFeature

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

Type Parameters:

T - feature Type

Parameters:

feature - Feature is present

Returns:

the feature

getSourcePath

public String getSourcePath(String path)

Parameters:

path - Path

Returns:

source path

getTestSourcePath

public String getTestSourcePath(String path)

Parameters:

path - Path

Returns:

test path

resolveCoordinate

public Coordinate resolveCoordinate(String artifactId)

Parameters:

artifactId - Artifact ID

Returns:

The coordinate

getModuleNames

public Collection<String> getModuleNames()

Returns:

Module Names

hasFeature

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

Type Parameters:

T - feature Type

Parameters:

featureClass - Feature class

Returns:

Whether the feature is present

findFrameworkDocumentationByRecipeName

public Optional<String> findFrameworkDocumentationByRecipeName(@NonNull
 @NonNull String recipeName)

Parameters:

recipeName - recipe Name

Returns:

documentation

findThirdPartyDocumentationByRecipeName

public Optional<String> findThirdPartyDocumentationByRecipeName(@NonNull
 @NonNull String recipeName)

Parameters:

recipeName - recipe Name

Returns:

documentation