Class DocEnv
java.lang.Object
gw.gosudoc.com.sun.tools.javadoc.main.DocEnv
Deprecated.
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.
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.
- Since:
- 1.4
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) booleanDeprecated.True if we are using a sentence BreakIterator.(package private) com.sun.tools.javac.comp.CheckDeprecated.protected Map<com.sun.tools.javac.code.Symbol.ClassSymbol,ClassDocImpl> Deprecated.(package private) com.sun.tools.javac.util.ContextDeprecated.(package private) booleanDeprecated.Allow documenting from class files?protected static final com.sun.tools.javac.util.Context.Key<DocEnv>Deprecated.(package private) com.sun.tools.doclint.DocLintDeprecated.(package private) DocLocaleDeprecated.private StringDeprecated.The encoding name.(package private) final com.sun.tools.javac.comp.EnterDeprecated.Javadoc's own version of the compiler's enter phase.(package private) final com.sun.tools.javac.code.SymbolDeprecated.protected Map<com.sun.tools.javac.code.Symbol.VarSymbol,FieldDocImpl> Deprecated.(package private) JavaFileManagerDeprecated.private final com.sun.tools.javac.code.ClassFinderDeprecated.Referenced directly in RootDocImpl.(package private) JavaScriptScannerDeprecated.protected booleanDeprecated.Does the doclet only expect pre-1.5 doclet API?private final MessagerDeprecated.protected Map<com.sun.tools.javac.code.Symbol.MethodSymbol,ExecutableMemberDocImpl> Deprecated.private final com.sun.tools.javac.util.NamesDeprecated.The name table.protected Map<com.sun.tools.javac.code.Symbol.PackageSymbol,PackageDocImpl> Deprecated.(package private) booleanDeprecated.True if we do not want to print any notifications at all.static final StringDeprecated.Deprecated.protected ModifierFilterDeprecated.Access filter (public, protected, ...).private booleanDeprecated.Set this to true if you would like to not emit any errors, warnings and notices.protected com.sun.tools.javac.code.SourceDeprecated.The source language version.private static final StringDeprecated.(package private) final com.sun.tools.javac.code.SymtabDeprecated.Predefined symbols known to the compiler.(package private) WeakHashMap<com.sun.tools.javac.tree.JCTree,com.sun.source.util.TreePath> Deprecated.(package private) com.sun.tools.javac.code.TypesDeprecated.static final StringDeprecated.static final StringDeprecated.static final StringDeprecated.static final StringDeprecated. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDocEnv(com.sun.tools.javac.util.Context context) Deprecated.Constructor -
Method Summary
Modifier and TypeMethodDescriptionvoiderror(SourcePosition pos, String key) Deprecated.Print error message, increment error count.voidDeprecated.Print error message, increment error count.voidDeprecated.Print error message, increment error count.voidDeprecated.Print error message, increment error count.voidDeprecated.Print error message, increment error count.voidexit()Deprecated.Exit, reporting errors and warnings.getAnnotationTypeElementDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth) Deprecated.Return the AnnotationTypeElementDoc for a MethodSymbol.getClassDoc(com.sun.tools.javac.code.Symbol.ClassSymbol clazz) Deprecated.Return the ClassDoc (or a subtype) of this class symbol.(package private) com.sun.tools.javac.code.Symbol.ClassSymbolgetClassSymbol(String name) Deprecated.Retrieve class symbol by fully-qualified name.getConstructorDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth) Deprecated.Return the ConstructorDoc for a MethodSymbol.Deprecated.Get the encoding.getFieldDoc(com.sun.tools.javac.code.Symbol.VarSymbol var) Deprecated.Return the FieldDoc of this var symbol.getMethodDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth) Deprecated.Return the MethodDoc for a MethodSymbol.getPackageDoc(com.sun.tools.javac.code.Symbol.PackageSymbol pack) Deprecated.Return the PackageDoc of this package symbol.(package private) ParameterizedTypeImplgetParameterizedType(com.sun.tools.javac.code.Type.ClassType t) Deprecated.Return the ParameterizedType of this instantiation.(package private) com.sun.source.util.TreePathgetTreePath(com.sun.tools.javac.tree.JCTree.JCCompilationUnit tree) Deprecated.(package private) com.sun.source.util.TreePathgetTreePath(com.sun.tools.javac.tree.JCTree.JCCompilationUnit toplevel, com.sun.tools.javac.tree.JCTree.JCClassDecl tree) Deprecated.(package private) com.sun.source.util.TreePathgetTreePath(com.sun.tools.javac.tree.JCTree.JCCompilationUnit toplevel, com.sun.tools.javac.tree.JCTree.JCClassDecl cdecl, com.sun.tools.javac.tree.JCTree tree) Deprecated.(package private) com.sun.source.util.TreePathgetTreePath(com.sun.tools.javac.tree.JCTree.JCCompilationUnit toplevel, com.sun.tools.javac.tree.JCTree.JCPackageDecl tree) Deprecated.(package private) voidinitDoclint(Collection<String> opts, Collection<String> customTagNames, String htmlVersion) Deprecated.(package private) JavaScriptScannerinitJavaScriptScanner(boolean allowScriptInComments) Deprecated.static DocEnvinstance(com.sun.tools.javac.util.Context context) Deprecated.protected static booleanisAnnotationType(com.sun.tools.javac.code.Symbol.ClassSymbol clazz) Deprecated.protected static booleanisAnnotationType(com.sun.tools.javac.tree.JCTree.JCClassDecl tree) Deprecated.protected booleanisVisible(com.sun.tools.javac.code.Symbol.ClassSymbol sym) Deprecated.Check the visibility if this is an nested class.Deprecated.Load ClassDoc by qualified name.lookupClass(String name) Deprecated.Look up ClassDoc by qualified name.lookupPackage(String name) Deprecated.Look up PackageDoc by qualified name.protected voidmakeAnnotationTypeElementDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth, com.sun.source.util.TreePath treePath) Deprecated.Create the AnnotationTypeElementDoc for a MethodSymbol.protected voidmakeClassDoc(com.sun.tools.javac.code.Symbol.ClassSymbol clazz, com.sun.source.util.TreePath treePath) Deprecated.Create the ClassDoc (or a subtype) for a class symbol.protected voidmakeConstructorDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth, com.sun.source.util.TreePath treePath) Deprecated.Create the ConstructorDoc for a MethodSymbol.protected voidmakeFieldDoc(com.sun.tools.javac.code.Symbol.VarSymbol var, com.sun.source.util.TreePath treePath) Deprecated.Create a FieldDoc for a var symbol.protected voidmakeMethodDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth, com.sun.source.util.TreePath treePath) Deprecated.Create a MethodDoc for this MethodSymbol.(package private) voidmakePackageDoc(com.sun.tools.javac.code.Symbol.PackageSymbol pack, com.sun.source.util.TreePath treePath) Deprecated.Create the PackageDoc (or a subtype) for a package symbol.voidDeprecated.Print a message.voidDeprecated.Print a message.voidDeprecated.Print a message.voidDeprecated.Print a message.voidprintError(SourcePosition pos, String msg) Deprecated.Print error message, increment error count.voidprintError(String msg) Deprecated.Print error message, increment error count.voidprintNotice(SourcePosition pos, String msg) Deprecated.Print a message.voidprintNotice(String msg) Deprecated.Print a message.voidprintWarning(SourcePosition pos, String msg) Deprecated.Print warning message, increment warning count.voidprintWarning(String msg) Deprecated.Print warning message, increment warning count.voidsetEncoding(String encoding) Deprecated.Set the encoding.voidDeprecated.Set the locale.voidsetSilent(boolean silent) Deprecated.(package private) booleanshouldCheck(com.sun.source.tree.CompilationUnitTree unit) Deprecated.booleanshouldDocument(com.sun.tools.javac.code.Symbol.ClassSymbol sym) Deprecated.check whether this class should be documented.booleanshouldDocument(com.sun.tools.javac.code.Symbol.MethodSymbol sym) Deprecated.Check whether this member should be documented.booleanshouldDocument(com.sun.tools.javac.code.Symbol.VarSymbol sym) Deprecated.Check whether this member should be documented.(package private) booleanDeprecated.(package private) static inttranslateModifiers(long flags) Deprecated.Convert modifier bits from private coding used by the compiler to that of java.lang.reflect.Modifier.voidDeprecated.Print warning message, increment warning count.voidDeprecated.Print warning message, increment warning count.voidDeprecated.Print warning message, increment warning count.voidDeprecated.Print warning message, increment warning count.voidDeprecated.Print warning message, increment warning count.
-
Field Details
-
XMSGS_OPTION
Deprecated.- See Also:
-
XMSGS_CUSTOM_PREFIX
Deprecated.- See Also:
-
STATS
Deprecated.- See Also:
-
XCUSTOM_TAGS_PREFIX
Deprecated.- See Also:
-
XCHECK_PACKAGE
Deprecated.- See Also:
-
SEPARATOR
Deprecated.- See Also:
-
docEnvKey
Deprecated. -
doclocale
DocLocale doclocaleDeprecated. -
messager
Deprecated. -
syms
final com.sun.tools.javac.code.Symtab symsDeprecated.Predefined symbols known to the compiler. -
finder
private final com.sun.tools.javac.code.ClassFinder finderDeprecated.Referenced directly in RootDocImpl. -
enter
final com.sun.tools.javac.comp.Enter enterDeprecated.Javadoc's own version of the compiler's enter phase. -
names
private final com.sun.tools.javac.util.Names namesDeprecated.The name table. -
encoding
Deprecated.The encoding name. -
externalizableSym
final com.sun.tools.javac.code.Symbol externalizableSymDeprecated. -
showAccess
Deprecated.Access filter (public, protected, ...). -
breakiterator
boolean breakiteratorDeprecated.True if we are using a sentence BreakIterator. -
quiet
boolean quietDeprecated.True if we do not want to print any notifications at all. -
chk
com.sun.tools.javac.comp.Check chkDeprecated. -
types
com.sun.tools.javac.code.Types typesDeprecated. -
fileManager
JavaFileManager fileManagerDeprecated. -
context
com.sun.tools.javac.util.Context contextDeprecated. -
doclint
com.sun.tools.doclint.DocLint doclintDeprecated. -
javaScriptScanner
JavaScriptScanner javaScriptScannerDeprecated. -
treePaths
WeakHashMap<com.sun.tools.javac.tree.JCTree,com.sun.source.util.TreePath> treePathsDeprecated. -
docClasses
boolean docClassesDeprecated.Allow documenting from class files? -
legacyDoclet
protected boolean legacyDocletDeprecated.Does the doclet only expect pre-1.5 doclet API? -
silent
private boolean silentDeprecated.Set this to true if you would like to not emit any errors, warnings and notices. -
source
protected com.sun.tools.javac.code.Source sourceDeprecated.The source language version. -
packageMap
Deprecated. -
classMap
Deprecated. -
fieldMap
Deprecated. -
methodMap
Deprecated. -
shouldCheck
Deprecated.
-
-
Constructor Details
-
DocEnv
protected DocEnv(com.sun.tools.javac.util.Context context) Deprecated.Constructor- Parameters:
context- Context for this javadoc instance.
-
-
Method Details
-
instance
Deprecated. -
setSilent
public void setSilent(boolean silent) Deprecated. -
lookupClass
Deprecated.Look up ClassDoc by qualified name. -
loadClass
Deprecated.Load ClassDoc by qualified name. -
lookupPackage
Deprecated.Look up PackageDoc by qualified name. -
getClassSymbol
Deprecated.Retrieve class symbol by fully-qualified name. -
setLocale
Deprecated.Set the locale. -
shouldDocument
public boolean shouldDocument(com.sun.tools.javac.code.Symbol.VarSymbol sym) Deprecated.Check whether this member should be documented. -
shouldDocument
public boolean shouldDocument(com.sun.tools.javac.code.Symbol.MethodSymbol sym) Deprecated.Check whether this member should be documented. -
shouldDocument
public boolean shouldDocument(com.sun.tools.javac.code.Symbol.ClassSymbol sym) Deprecated.check whether this class should be documented. -
isVisible
protected boolean isVisible(com.sun.tools.javac.code.Symbol.ClassSymbol sym) Deprecated.Check the visibility if this is an nested class. if this is not a nested class, return true. if this is an static visible nested class, return true. if this is an visible nested class if the outer class is visible return true. else return false. IMPORTANT: This also allows, static nested classes to be defined inside an nested class, which is not allowed by the compiler. So such an test case will not reach upto this method itself, but if compiler allows it, then that will go through. -
printError
Deprecated.Print error message, increment error count.- Parameters:
msg- message to print.
-
error
Deprecated.Print error message, increment error count.- Parameters:
key- selects message from resource
-
error
Deprecated.Print error message, increment error count.- Parameters:
key- selects message from resource
-
printError
Deprecated.Print error message, increment error count.- Parameters:
msg- message to print.
-
error
Deprecated.Print error message, increment error count.- Parameters:
key- selects message from resourcea1- first argument
-
error
Deprecated.Print error message, increment error count.- Parameters:
key- selects message from resourcea1- first argumenta2- second argument
-
error
Deprecated.Print error message, increment error count.- Parameters:
key- selects message from resourcea1- first argumenta2- second argumenta3- third argument
-
printWarning
Deprecated.Print warning message, increment warning count.- Parameters:
msg- message to print.
-
warning
Deprecated.Print warning message, increment warning count.- Parameters:
key- selects message from resource
-
printWarning
Deprecated.Print warning message, increment warning count.- Parameters:
msg- message to print.
-
warning
Deprecated.Print warning message, increment warning count.- Parameters:
key- selects message from resourcea1- first argument
-
warning
Deprecated.Print warning message, increment warning count.- Parameters:
key- selects message from resourcea1- first argumenta2- second argument
-
warning
Deprecated.Print warning message, increment warning count.- Parameters:
key- selects message from resourcea1- first argumenta2- second argumenta3- third argument
-
warning
Deprecated.Print warning message, increment warning count.- Parameters:
key- selects message from resourcea1- first argumenta2- second argumenta3- third argument
-
printNotice
Deprecated.Print a message.- Parameters:
msg- message to print.
-
notice
Deprecated.Print a message.- Parameters:
key- selects message from resource
-
printNotice
Deprecated.Print a message.- Parameters:
msg- message to print.
-
notice
Deprecated.Print a message.- Parameters:
key- selects message from resourcea1- first argument
-
notice
Deprecated.Print a message.- Parameters:
key- selects message from resourcea1- first argumenta2- second argument
-
notice
Deprecated.Print a message.- Parameters:
key- selects message from resourcea1- first argumenta2- second argumenta3- third argument
-
exit
public void exit()Deprecated.Exit, reporting errors and warnings. -
getPackageDoc
Deprecated.Return the PackageDoc of this package symbol. -
makePackageDoc
void makePackageDoc(com.sun.tools.javac.code.Symbol.PackageSymbol pack, com.sun.source.util.TreePath treePath) Deprecated.Create the PackageDoc (or a subtype) for a package symbol. -
getClassDoc
Deprecated.Return the ClassDoc (or a subtype) of this class symbol. -
makeClassDoc
protected void makeClassDoc(com.sun.tools.javac.code.Symbol.ClassSymbol clazz, com.sun.source.util.TreePath treePath) Deprecated.Create the ClassDoc (or a subtype) for a class symbol. -
isAnnotationType
protected static boolean isAnnotationType(com.sun.tools.javac.code.Symbol.ClassSymbol clazz) Deprecated. -
isAnnotationType
protected static boolean isAnnotationType(com.sun.tools.javac.tree.JCTree.JCClassDecl tree) Deprecated. -
getFieldDoc
Deprecated.Return the FieldDoc of this var symbol. -
makeFieldDoc
protected void makeFieldDoc(com.sun.tools.javac.code.Symbol.VarSymbol var, com.sun.source.util.TreePath treePath) Deprecated.Create a FieldDoc for a var symbol. -
makeMethodDoc
protected void makeMethodDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth, com.sun.source.util.TreePath treePath) Deprecated.Create a MethodDoc for this MethodSymbol. Should be called only on symbols representing methods. -
getMethodDoc
Deprecated.Return the MethodDoc for a MethodSymbol. Should be called only on symbols representing methods. -
makeConstructorDoc
protected void makeConstructorDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth, com.sun.source.util.TreePath treePath) Deprecated.Create the ConstructorDoc for a MethodSymbol. Should be called only on symbols representing constructors. -
getConstructorDoc
Deprecated.Return the ConstructorDoc for a MethodSymbol. Should be called only on symbols representing constructors. -
makeAnnotationTypeElementDoc
protected void makeAnnotationTypeElementDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth, com.sun.source.util.TreePath treePath) Deprecated.Create the AnnotationTypeElementDoc for a MethodSymbol. Should be called only on symbols representing annotation type elements. -
getAnnotationTypeElementDoc
public AnnotationTypeElementDocImpl getAnnotationTypeElementDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth) Deprecated.Return the AnnotationTypeElementDoc for a MethodSymbol. Should be called only on symbols representing annotation type elements. -
getParameterizedType
Deprecated.Return the ParameterizedType of this instantiation. // * ### Could use Type.sameTypeAs() instead of equality matching in hashmap // * ### to avoid some duplication. -
getTreePath
com.sun.source.util.TreePath getTreePath(com.sun.tools.javac.tree.JCTree.JCCompilationUnit tree) Deprecated. -
getTreePath
com.sun.source.util.TreePath getTreePath(com.sun.tools.javac.tree.JCTree.JCCompilationUnit toplevel, com.sun.tools.javac.tree.JCTree.JCPackageDecl tree) Deprecated. -
getTreePath
com.sun.source.util.TreePath getTreePath(com.sun.tools.javac.tree.JCTree.JCCompilationUnit toplevel, com.sun.tools.javac.tree.JCTree.JCClassDecl tree) Deprecated. -
getTreePath
com.sun.source.util.TreePath getTreePath(com.sun.tools.javac.tree.JCTree.JCCompilationUnit toplevel, com.sun.tools.javac.tree.JCTree.JCClassDecl cdecl, com.sun.tools.javac.tree.JCTree tree) Deprecated. -
setEncoding
Deprecated.Set the encoding. -
getEncoding
Deprecated.Get the encoding. -
translateModifiers
static int translateModifiers(long flags) Deprecated.Convert modifier bits from private coding used by the compiler to that of java.lang.reflect.Modifier. -
initDoclint
Deprecated. -
initJavaScriptScanner
Deprecated. -
showTagMessages
boolean showTagMessages()Deprecated. -
shouldCheck
boolean shouldCheck(com.sun.source.tree.CompilationUnitTree unit) Deprecated.
-