org.agrona.generation

Class PackageOutputManager

java.lang.Object

org.agrona.generation.PackageOutputManager

All Implemented Interfaces:

OutputManager

public class PackageOutputManager
extends Object
implements OutputManager

OutputManager for managing the creation of Java source files as the target of code generation. The character encoding for the Writer is UTF-8.

Constructor Summary

Constructors

Constructor and Description
PackageOutputManager(String baseDirName, String packageName) Create a new OutputManager for generating Java source files into a given package.

Method Summary

Modifier and Type	Method and Description
Writer	createOutput(String name) Create a new output which will be a Java source file in the given package.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.agrona.generation.OutputManager

withOutput

Constructor Detail

PackageOutputManager

public PackageOutputManager(String baseDirName,
                            String packageName)

Create a new OutputManager for generating Java source files into a given package.

Parameters:

baseDirName - for the generated source code.

packageName - for the generated source code relative to the baseDirName.

Method Detail

createOutput

public Writer createOutput(String name)
                    throws IOException

Create a new output which will be a Java source file in the given package.

The Writer should be closed once the caller has finished with it. The Writer is buffered for efficient IO operations.

Specified by:

createOutput in interface OutputManager

Parameters:

name - the name of the Java class.

Returns:

a Writer to which the source code should be written.

Throws:

IOException - if an issue occurs when creating the file.