APIdia Launch Partner
Top Description Inners Methods
com.sun.tools.javac.platform

public Interface PlatformDescription

extends Closeable
Known Direct Implementers
com.sun.tools.javac.platform.JDKPlatformProvider.PlatformDescriptionImpl
Imports
java.io.Closeable, .IOException, java.util.List, .Map, javax.annotation.processing.Processor, javax.tools.JavaFileManager, com.sun.source.util.Plugin
A description of settings needed for a particular --release name option.

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.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
PlatformDescription.PluginInfo<
either Processor or Plugin
T>

Returns the description of annotation Processor or javac Plugin that should be enabled in the current javac run.

Method Summary

Modifier and TypeMethod and Description
public void
close()

Redeclares java.io.Closeable.close.

Perform cleanup for this PlatformProvider - this instance won't be used after this method is called.

public List<String>

Returns:

additional command line options
getAdditionalOptions()

Returns the additional command line options that should be passed to javac.

public List<PlatformDescription.PluginInfo<Processor>>

Returns:

annotation Processors
getAnnotationProcessors()

Returns the annotation Processors that should be enabled in the current javac run.

public JavaFileManager
getFileManager()

public List<PlatformDescription.PluginInfo<Plugin>>

Returns:

javac Plugins
getPlugins()

Returns the javac Plugins that should be enabled in the current javac run.

public String

Returns:

the required source version
getSourceVersion()

Returns the source version that should be selected.

public String

Returns:

the required target version
getTargetVersion()

Returns the target version that should be selected.

Method Detail

closeback to summary
public void close() throws IOException

Redeclares java.io.Closeable.close.

Perform cleanup for this PlatformProvider - this instance won't be used after this method is called.

Exceptions
IOException:
if unexpected problems occur during closing this provider
getAdditionalOptionsback to summary
public List<String> getAdditionalOptions()

Returns the additional command line options that should be passed to javac.

Returns:List<String>

additional command line options

getAnnotationProcessorsback to summary
public List<PlatformDescription.PluginInfo<Processor>> getAnnotationProcessors()

Returns the annotation Processors that should be enabled in the current javac run.

Returns:List<PlatformDescription.PluginInfo<Processor>>

annotation Processors

getFileManagerback to summary
public JavaFileManager getFileManager()
getPluginsback to summary
public List<PlatformDescription.PluginInfo<Plugin>> getPlugins()

Returns the javac Plugins that should be enabled in the current javac run.

Returns:List<PlatformDescription.PluginInfo<Plugin>>

javac Plugins

getSourceVersionback to summary
public String getSourceVersion()

Returns the source version that should be selected. Equivalent to -source N on the command line.

Returns:String

the required source version

getTargetVersionback to summary
public String getTargetVersion()

Returns the target version that should be selected. Equivalent to -target N on the command line.

Returns:String

the required target version

com.sun.tools.javac.platform back to summary

public Interface PlatformDescription.PluginInfo<T>

Type Parameters
<T>
either Processor or Plugin
Returns the description of annotation Processor or javac Plugin that should be enabled in the current javac run.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

name of the Processor or Plugin.
getName()

Returns the name of the Processor or Plugin.

public Map<String, String>

Returns:

the options
getOptions()

Returns the options for the Processor or Plugin.

public T

Returns:

the Processor or Plugin instance.
getPlugin()

Returns the Processor or Plugin instance.

Method Detail

getNameback to summary
public String getName()

Returns the name of the Processor or Plugin.

Returns:String

name of the Processor or Plugin.

getOptionsback to summary
public Map<String, String> getOptions()

Returns the options for the Processor or Plugin. For plugin, the map will be converted to a collection by concatenating the map's keys, the '=' sign and the map's values.

Returns:Map<String, String>

the options

getPluginback to summary
public T getPlugin()

Returns the Processor or Plugin instance.

Returns:T

the Processor or Plugin instance.