/*
* Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package org.openjdk.jmh.generators.core;
import java.io.*;
Generator destination.
The exit point for BenchmarkGenerator
.
/**
* Generator destination.
*
* <p>The exit point for {@link org.openjdk.jmh.generators.core.BenchmarkGenerator}.</p>
*/
public interface GeneratorDestination {
Returns the stream for the given resource.
Callers are responsible for closing streams.
Params: - resourcePath – resource path
Throws: - IOException – if something wacked happens
Returns: output stream to write the resource to.
/**
* Returns the stream for the given resource.
* Callers are responsible for closing streams.
*
* @param resourcePath resource path
* @return output stream to write the resource to.
* @throws java.io.IOException if something wacked happens
*/
OutputStream newResource(String resourcePath) throws IOException;
Returns the stream for the given resource.
Callers are responsible for closing streams.
Params: - resourcePath – resource path
Throws: - IOException – if something wacked happens
Returns: stream usable to read the resource
/**
* Returns the stream for the given resource.
* Callers are responsible for closing streams.
*
* @param resourcePath resource path
* @return stream usable to read the resource
* @throws java.io.IOException if something wacked happens
*/
InputStream getResource(String resourcePath) throws IOException;
Returns the Writer for the given class.
Callers are responsible for closing Writers.
Params: - className – class name
Throws: - IOException – if something wacked happens
Returns: writer usable to write the resource
/**
* Returns the Writer for the given class.
* Callers are responsible for closing Writers.
*
* @param className class name
* @return writer usable to write the resource
* @throws IOException if something wacked happens
*/
Writer newClass(String className) throws IOException;
Print the error.
Calling this method should not terminate anything.
Params: - message – error.
/**
* Print the error.
* Calling this method should not terminate anything.
*
* @param message error.
*/
void printError(String message);
Print the error.
Calling this method should not terminate anything.
Params: - message – error.
- element – metadata element, to which this error is tailored
/**
* Print the error.
* Calling this method should not terminate anything.
*
* @param message error.
* @param element metadata element, to which this error is tailored
*/
void printError(String message, MetadataInfo element);
Print the error.
Calling this method should not terminate anything.
Params: - message – error.
- throwable – exception causing the error
/**
* Print the error.
* Calling this method should not terminate anything.
*
* @param message error.
* @param throwable exception causing the error
*/
void printError(String message, Throwable throwable);
Print the warning.
Calling this method should not terminate anything.
Params: - message – warning.
/**
* Print the warning.
* Calling this method should not terminate anything.
*
* @param message warning.
*/
void printWarning(String message);
Print the warning.
Calling this method should not terminate anything.
Params: - message – warning.
- element – metadata element, to which this error is tailored
/**
* Print the warning.
* Calling this method should not terminate anything.
*
* @param message warning.
* @param element metadata element, to which this error is tailored
*/
void printWarning(String message, MetadataInfo element);
Print the warning.
Calling this method should not terminate anything.
Params: - message – warning.
- throwable – exception causing the error
/**
* Print the warning.
* Calling this method should not terminate anything.
*
* @param message warning.
* @param throwable exception causing the error
*/
void printWarning(String message, Throwable throwable);
Print the informative message.
Calling this method should not terminate anything.
Params: - message – message.
/**
* Print the informative message.
* Calling this method should not terminate anything.
*
* @param message message.
*/
void printNote(String message);
}