org.openjdk.jmh.generators.core

Interface GeneratorDestination

All Known Implementing Classes:

FileSystemDestination

public interface GeneratorDestination

Generator destination.

The exit point for BenchmarkGenerator.

Method Summary

Methods

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

Method Detail

newResource

Writer newResource(String resourcePath)
                   throws IOException

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

Parameters:

resourcePath - resource path

Returns:

writer usable to write the resource

Throws:

IOException - if something wacked happens

getResource

Reader getResource(String resourcePath)
                   throws IOException

Returns the Reader for the given resource. Callers are responsible for closing Readers.

Parameters:

resourcePath - resource path

Returns:

reader usable to read the resource

Throws:

IOException - if something wacked happens

newClass

Writer newClass(String className)
                throws IOException

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

Parameters:

className - class name

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.