Package com.sun.tools.javah

Interface NativeHeaderTool

All Superinterfaces:

OptionChecker, Tool

All Known Implementing Classes:

JavahTool

public interface NativeHeaderTool
extends Tool, OptionChecker

This class is intended to be put in javax.tools.

Since:

1.7

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

See Also:

DiagnosticListener, Diagnostic, JavaFileManager

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NativeHeaderTool.NativeHeaderTask Interface representing a future for a native header task.

Method Summary

Modifier and Type	Method and Description
StandardJavaFileManager	getStandardFileManager(DiagnosticListener<? super JavaFileObject> diagnosticListener, Locale locale, Charset charset) Gets a new instance of the standard file manager implementation for this tool.
NativeHeaderTool.NativeHeaderTask	getTask(Writer out, JavaFileManager fileManager, DiagnosticListener<? super JavaFileObject> diagnosticListener, Iterable<String> options, Iterable<String> classes) Creates a future for a native header task with the given components and arguments.

Methods inherited from interface javax.tools.Tool

getSourceVersions, name, run

Methods inherited from interface javax.tools.OptionChecker

isSupportedOption

Method Detail

getTask

NativeHeaderTool.NativeHeaderTask getTask(Writer out,
                                          JavaFileManager fileManager,
                                          DiagnosticListener<? super JavaFileObject> diagnosticListener,
                                          Iterable<String> options,
                                          Iterable<String> classes)

Creates a future for a native header task with the given components and arguments. The task might not have completed as described in the NativeHeaderTask interface.

If a file manager is provided, it must be able to handle all locations defined in StandardLocation.

Parameters:

out - a Writer for additional output from the task; use System.err if null

fileManager - a file manager; if null use the task's standard filemanager

diagnosticListener - a diagnostic listener; if null use the compiler's default method for reporting diagnostics

options - task options, null means no options

classes - class names for which native headers should be generated

Returns:

an object representing the task to be done

Throws:

RuntimeException - if an unrecoverable error occurred in a user supplied component. The cause will be the error in user code.

IllegalArgumentException - if any of the given compilation units are of other kind than source

getStandardFileManager

StandardJavaFileManager getStandardFileManager(DiagnosticListener<? super JavaFileObject> diagnosticListener,
                                               Locale locale,
                                               Charset charset)

Gets a new instance of the standard file manager implementation for this tool. The file manager will use the given diagnostic listener for producing any non-fatal diagnostics. Fatal errors will be signalled with the appropriate exceptions.

The standard file manager will be automatically reopened if it is accessed after calls to flush or close. The standard file manager must be usable with other tools.

Parameters:

diagnosticListener - a diagnostic listener for non-fatal diagnostics; if null use the tool's default method for reporting diagnostics

locale - the locale to apply when formatting diagnostics; null means the default locale.

charset - the character set used for decoding bytes; if null use the platform default

Returns:

the standard file manager