Package org.springframework.aot.generate

Class DefaultGenerationContext

java.lang.Object

org.springframework.aot.generate.DefaultGenerationContext

All Implemented Interfaces:

GenerationContext

public class DefaultGenerationContext
extends Object
implements GenerationContext

Default GenerationContext implementation.

Since:

6.0

Author:

Phillip Webb, Stephane Nicoll

Constructor Summary

Constructors

Constructor	Description
DefaultGenerationContext(ClassNameGenerator classNameGenerator, GeneratedFiles generatedFiles)	Create a new DefaultGenerationContext instance backed by the specified ClassNameGenerator and GeneratedFiles.
DefaultGenerationContext(GeneratedClasses generatedClasses, GeneratedFiles generatedFiles, RuntimeHints runtimeHints)	Create a new DefaultGenerationContext instance backed by the specified items.

Method Summary

Modifier and Type	Method	Description
GeneratedClasses	getGeneratedClasses()	Return the GeneratedClasses being used by the context.
GeneratedFiles	getGeneratedFiles()	Return the GeneratedFiles being used by the context.
RuntimeHints	getRuntimeHints()	Return the RuntimeHints being used by the context.
GenerationContext	withName(String name)	Return a new GenerationContext instance using the specified name to qualify generated assets for a dedicated round of code generation.
void	writeGeneratedContent()	Write any generated content out to the generated files.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultGenerationContext

public DefaultGenerationContext(ClassNameGenerator classNameGenerator,
 GeneratedFiles generatedFiles)

Create a new DefaultGenerationContext instance backed by the specified ClassNameGenerator and GeneratedFiles.

Parameters:

classNameGenerator - the naming convention to use for generated class names

generatedFiles - the generated files

DefaultGenerationContext

public DefaultGenerationContext(GeneratedClasses generatedClasses,
 GeneratedFiles generatedFiles,
 RuntimeHints runtimeHints)

Create a new DefaultGenerationContext instance backed by the specified items.

Parameters:

generatedClasses - the generated classes

generatedFiles - the generated files

runtimeHints - the runtime hints

Method Details

getGeneratedClasses

public GeneratedClasses getGeneratedClasses()

Description copied from interface: GenerationContext

Return the GeneratedClasses being used by the context. Allows a single generated class to be shared across multiple AOT processors. All generated classes are written at the end of AOT processing.

Specified by:

getGeneratedClasses in interface GenerationContext

Returns:

the generated classes

getGeneratedFiles

public GeneratedFiles getGeneratedFiles()

Description copied from interface: GenerationContext

Return the GeneratedFiles being used by the context. Used to write resource, java source or class bytecode files.

Specified by:

getGeneratedFiles in interface GenerationContext

Returns:

the generated files

getRuntimeHints

public RuntimeHints getRuntimeHints()

Description copied from interface: GenerationContext

Return the RuntimeHints being used by the context. Used to record reflection, resource, serialization and proxy hints so that the application can run as a native image.

Specified by:

getRuntimeHints in interface GenerationContext

Returns:

the runtime hints

withName

public GenerationContext withName(String name)

Description copied from interface: GenerationContext

Return a new GenerationContext instance using the specified name to qualify generated assets for a dedicated round of code generation. If this name is already in use, a unique sequence is added to ensure the name is unique.

Specified by:

withName in interface GenerationContext

Parameters:

name - the name to use

Returns:

a specialized GenerationContext for the specified name

writeGeneratedContent

public void writeGeneratedContent()

Write any generated content out to the generated files.