Package org.openjdk.jmh.generators.core

Interface GeneratorDestination

All Known Implementing Classes:

FileSystemDestination

public interface GeneratorDestination

Generator destination.

The exit point for BenchmarkGenerator.

Method Summary

Modifier and Type	Method	Description
InputStream	getResource(String resourcePath)	Returns the stream for the given resource.
Writer	newClass(String className, String originatingClassName)	Returns the Writer for the given class.
OutputStream	newResource(String resourcePath)	Returns the stream for the given resource.
void	printError(String message)	Print the error.
void	printError(String message, Throwable throwable)	Print the error.
void	printError(String message, MetadataInfo element)	Print the error.
void	printNote(String message)	Print the informative message.
void	printWarning(String message)	Print the warning.
void	printWarning(String message, Throwable throwable)	Print the warning.
void	printWarning(String message, MetadataInfo element)	Print the warning.

Method Detail

newResource

OutputStream newResource(String resourcePath)
                  throws IOException

Returns the stream for the given resource. Callers are responsible for closing streams.

Parameters:

resourcePath - resource path

Returns:

output stream to write the resource to.

Throws:

IOException - if something wacked happens

getResource

InputStream getResource(String resourcePath)
                 throws IOException

Returns the stream for the given resource. Callers are responsible for closing streams.

Parameters:

resourcePath - resource path

Returns:

stream usable to read the resource

Throws:

IOException - if something wacked happens

newClass

Writer newClass(String className,
                String originatingClassName)
         throws IOException

Returns the Writer for the given class. Callers are responsible for closing Writers.

Parameters:

className - class name

originatingClassName - class name causing the creation of this class

Returns:

writer usable to write the resource

Throws:

IOException - if something wacked happens

printError

void printError(String message)

Print the error. Calling this method should not terminate anything.

Parameters:

message - error.

printError

void printError(String message,
                MetadataInfo element)

Print the error. Calling this method should not terminate anything.

Parameters:

message - error.

element - metadata element, to which this error is tailored

printError

void printError(String message,
                Throwable throwable)

Print the error. Calling this method should not terminate anything.

Parameters:

message - error.

throwable - exception causing the error

printWarning

void printWarning(String message)

Print the warning. Calling this method should not terminate anything.

Parameters:

message - warning.

printWarning

void printWarning(String message,
                  MetadataInfo element)

Print the warning. Calling this method should not terminate anything.

Parameters:

message - warning.

element - metadata element, to which this error is tailored

printWarning

void printWarning(String message,
                  Throwable throwable)

Print the warning. Calling this method should not terminate anything.

Parameters:

message - warning.

throwable - exception causing the error

printNote

void printNote(String message)

Print the informative message. Calling this method should not terminate anything.

Parameters:

message - message.