APIdia Launch Partner
Top Description Fields Constructors Methods
jdk.javadoc.internal.tool

public Class ToolEnvironment

extends Object
Class Inheritance
Imports
java.util.*, javax.lang.model.element.Element, .TypeElement, javax.lang.model.util.Elements, javax.lang.model.type.TypeKind, javax.tools.JavaFileManager, .JavaFileObject, .JavaFileObject.Kind, com.sun.source.util.DocTrees, .TreePath, com.sun.tools.javac.api.JavacTrees, com.sun.tools.javac.code.ClassFinder, .Flags, .Source, .Symbol, .Symbol.ClassSymbol, .Symbol.CompletionFailure, .Symbol.ModuleSymbol, .Symtab, com.sun.tools.javac.comp.AttrContext, .Check, .Enter, .Env, com.sun.tools.javac.file.JavacFileManager, com.sun.tools.javac.model.JavacElements, .JavacTypes, com.sun.tools.javac.tree.JCTree, .JCTree.JCClassDecl, .JCTree.JCCompilationUnit, .JCTree.JCPackageDecl, com.sun.tools.javac.util.Context, .Convert, .Name, .Names
Holds the environment for a run of javadoc. Holds only the information needed throughout the run and not the compiler info that could be GC'ed or ported.

Field Summary

Modifier and TypeField and Description
pack-priv Check
chk

public final Context
context

pack-priv boolean
docClasses

Allow documenting from class files?

protected DocEnvImpl
docEnv

public final DocTrees
docTrees

public final Elements
elements

public final Map<Element, TreePath>
elementToTreePath

pack-priv final Enter
enter

Javadoc's subtype of the compiler's enter phase.

pack-priv JavaFileManager
fileManager

private final ClassFinder
finder

JavaDoc's subtype of the compiler's class finder

pack-priv boolean
ignoreSourceErrors

If true, ignore all errors encountered during Enter.

pack-priv final JavadocLog
log

private Names
names

The name table.

pack-priv boolean
quiet

If true, prevent printing of any notifications.

public final Source
source

The source language version.

public final Symtab
syms

Predefined symbols known to the compiler.

protected static final Context.Key<ToolEnvironment>
ToolEnvKey

pack-priv WeakHashMap<JCTree, TreePath>
treePaths

pack-priv Types
types

public final JavacTypes
typeutils

Constructor Summary

AccessConstructor and Description
protected
ToolEnvironment(Context
Context for this javadoc instance.
context)

Constructor

Method Summary

Modifier and TypeMethod and Description
public Env<AttrContext>
getEnv(Symbol.ClassSymbol tsym)

public JavaFileObject.Kind
getFileKind(TypeElement te)

pack-priv TreePath
getTreePath(JCTree.JCCompilationUnit tree)

pack-priv TreePath
getTreePath(JCTree.JCCompilationUnit toplevel, JCTree.JCPackageDecl tree)

pack-priv TreePath
getTreePath(JCTree.JCCompilationUnit toplevel, JCTree.JCClassDecl tree)

pack-priv TreePath
getTreePath(JCTree.JCCompilationUnit toplevel, JCTree.JCClassDecl cdecl, JCTree tree)

public Types
getTypes()

public void
initialize(ToolOptions options)

public static ToolEnvironment
instance(Context context)

pack-priv boolean
isSynthetic(Symbol sym)

public TypeElement
loadClass(String name)

Load a class by qualified name.

public void
printInfo(String
selects message from resource
key, Object... args)

Prints a notice unless -quiet was specified.

pack-priv void
setElementToTreePath(Element e, TreePath tree)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

chkback to summary
pack-priv Check chk
contextback to summary
public final Context context
docClassesback to summary
pack-priv boolean docClasses

Allow documenting from class files?

docEnvback to summary
protected DocEnvImpl docEnv
docTreesback to summary
public final DocTrees docTrees
elementsback to summary
public final Elements elements
elementToTreePathback to summary
public final Map<Element, TreePath> elementToTreePath
enterback to summary
pack-priv final Enter enter

Javadoc's subtype of the compiler's enter phase.

fileManagerback to summary
pack-priv JavaFileManager fileManager
finderback to summary
private final ClassFinder finder

JavaDoc's subtype of the compiler's class finder

ignoreSourceErrorsback to summary
pack-priv boolean ignoreSourceErrors

If true, ignore all errors encountered during Enter.

logback to summary
pack-priv final JavadocLog log
namesback to summary
private Names names

The name table.

quietback to summary
pack-priv boolean quiet

If true, prevent printing of any notifications.

sourceback to summary
public final Source source

The source language version.

symsback to summary
public final Symtab syms

Predefined symbols known to the compiler.

ToolEnvKeyback to summary
protected static final Context.Key<ToolEnvironment> ToolEnvKey
treePathsback to summary
pack-priv WeakHashMap<JCTree, TreePath> treePaths
typesback to summary
pack-priv Types types
typeutilsback to summary
public final JavacTypes typeutils

Constructor Detail

ToolEnvironmentback to summary
protected ToolEnvironment(Context context)

Constructor

Parameters
context:Context

Context for this javadoc instance.

Method Detail

getEnvback to summary
public Env<AttrContext> getEnv(Symbol.ClassSymbol tsym)
getFileKindback to summary
public JavaFileObject.Kind getFileKind(TypeElement te)
getTreePathback to summary
pack-priv TreePath getTreePath(JCTree.JCCompilationUnit tree)
getTreePathback to summary
pack-priv TreePath getTreePath(JCTree.JCCompilationUnit toplevel, JCTree.JCPackageDecl tree)
getTreePathback to summary
pack-priv TreePath getTreePath(JCTree.JCCompilationUnit toplevel, JCTree.JCClassDecl tree)
getTreePathback to summary
pack-priv TreePath getTreePath(JCTree.JCCompilationUnit toplevel, JCTree.JCClassDecl cdecl, JCTree tree)
getTypesback to summary
public Types getTypes()
initializeback to summary
public void initialize(ToolOptions options)
instanceback to summary
public static ToolEnvironment instance(Context context)
isSyntheticback to summary
pack-priv boolean isSynthetic(Symbol sym)
loadClassback to summary
public TypeElement loadClass(String name)

Load a class by qualified name.

printInfoback to summary
public void printInfo(String key, Object... args)

Prints a notice unless -quiet was specified.

Parameters
key:String

selects message from resource

setElementToTreePathback to summary
pack-priv void setElementToTreePath(Element e, TreePath tree)