io.micronaut.ast.groovy.utils

Class InMemoryClassWriterOutputVisitor

java.lang.Object

io.micronaut.ast.groovy.utils.InMemoryClassWriterOutputVisitor

All Implemented Interfaces:

ClassWriterOutputVisitor

public class InMemoryClassWriterOutputVisitor
extends Object
implements ClassWriterOutputVisitor

Utility class for testing Groovy visitors.

Since:

3.0.0

Author:

graemerocher

Constructor Summary

Constructors

Constructor and Description
InMemoryClassWriterOutputVisitor(InMemoryByteCodeGroovyClassLoader classLoader)

Method Summary

Modifier and Type	Method and Description
void	finish() Finish writing and flush any service entries to disk.
OutputStream	visitClass(String classname, Element... originatingElements) Visits a new class and returns the output stream with which should be written the bytes of the class to be generated.
Optional<GeneratedFile>	visitGeneratedFile(String path) Visit a file that will be generated within the generated sources directory.
Optional<GeneratedFile>	visitMetaInfFile(String path, Element... originatingElements) Visit a file within the META-INF directory of the classes directory.
void	visitServiceDescriptor(String type, String classname) Allows adding a class that will be written to the META-INF/services file under the given type and class name.
void	visitServiceDescriptor(String type, String classname, Element originatingElement) Allows adding a class that will be written to the META-INF/services file under the given type and class name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.inject.writer.ClassWriterOutputVisitor

getServiceEntries, visitClass, visitClass, visitMetaInfFile, visitServiceDescriptor, visitServiceDescriptor

Constructor Detail

InMemoryClassWriterOutputVisitor

public InMemoryClassWriterOutputVisitor(InMemoryByteCodeGroovyClassLoader classLoader)

Parameters:

classLoader - The in-memory classloader

Method Detail

visitClass

public OutputStream visitClass(String classname,
                               Element... originatingElements)
                        throws IOException

Description copied from interface: ClassWriterOutputVisitor

Visits a new class and returns the output stream with which should be written the bytes of the class to be generated.

Note that this method should only be called from a TypeElementVisitor.VisitorKind.AGGREGATING visitor from within the TypeElementVisitor.finish(io.micronaut.inject.visitor.VisitorContext) method. If the file

Specified by:

visitClass in interface ClassWriterOutputVisitor

Parameters:

classname - the fully qualified classname

originatingElements - The originating elements

Returns:

the output stream to write to

Throws:

IOException - if an error occurs creating the output stream

visitServiceDescriptor

public final void visitServiceDescriptor(String type,
                                         String classname)

Description copied from interface: ClassWriterOutputVisitor

Allows adding a class that will be written to the META-INF/services file under the given type and class name.

Specified by:

visitServiceDescriptor in interface ClassWriterOutputVisitor

Parameters:

type - the fully qualified service name

classname - the fully qualified classname

visitServiceDescriptor

public void visitServiceDescriptor(String type,
                                   String classname,
                                   Element originatingElement)

Description copied from interface: ClassWriterOutputVisitor

Allows adding a class that will be written to the META-INF/services file under the given type and class name.

Specified by:

visitServiceDescriptor in interface ClassWriterOutputVisitor

Parameters:

type - the fully qualified service name

classname - the fully qualified classname

originatingElement - The originating element

visitMetaInfFile

public Optional<GeneratedFile> visitMetaInfFile(String path,
                                                Element... originatingElements)

Description copied from interface: ClassWriterOutputVisitor

Visit a file within the META-INF directory of the classes directory.

Specified by:

visitMetaInfFile in interface ClassWriterOutputVisitor

Parameters:

path - The path to the file

originatingElements - The originating elements

Returns:

An optional file it was possible to create it

visitGeneratedFile

public Optional<GeneratedFile> visitGeneratedFile(String path)

Description copied from interface: ClassWriterOutputVisitor

Visit a file that will be generated within the generated sources directory.

Specified by:

visitGeneratedFile in interface ClassWriterOutputVisitor

Parameters:

path - The path

Returns:

The file if it was possible to create it

finish

public void finish()

Description copied from interface: ClassWriterOutputVisitor

Finish writing and flush any service entries to disk.

Specified by:

finish in interface ClassWriterOutputVisitor