Class DocEnv
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.javadoc.main.DocEnv
-
@Deprecated public class DocEnv extends Object
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
- Author:
- Robert Field, Neal Gafter (rewrite), Scott Seligman (generics)
-
-
Field Summary
Fields Modifier and Type Field Description protected Map<com.sun.tools.javac.code.Symbol.ClassSymbol,ClassDocImpl>
classMap
Deprecated.protected static com.sun.tools.javac.util.Context.Key<DocEnv>
docEnvKey
Deprecated.protected Map<com.sun.tools.javac.code.Symbol.VarSymbol,FieldDocImpl>
fieldMap
Deprecated.protected boolean
legacyDoclet
Deprecated.Does the doclet only expect pre-1.5 doclet API?protected Map<com.sun.tools.javac.code.Symbol.MethodSymbol,ExecutableMemberDocImpl>
methodMap
Deprecated.protected Map<com.sun.tools.javac.code.Symbol.PackageSymbol,PackageDocImpl>
packageMap
Deprecated.static String
SEPARATOR
Deprecated.protected ModifierFilter
showAccess
Deprecated.Access filter (public, protected, ...).protected com.sun.tools.javac.code.Source
source
Deprecated.The source language version.static String
XCHECK_PACKAGE
Deprecated.static String
XCUSTOM_TAGS_PREFIX
Deprecated.static String
XMSGS_CUSTOM_PREFIX
Deprecated.static String
XMSGS_OPTION
Deprecated.
-
Constructor Summary
Constructors Modifier Constructor Description protected
DocEnv(com.sun.tools.javac.util.Context context)
Deprecated.Constructor
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
error(SourcePosition pos, String key)
Deprecated.Print error message, increment error count.void
error(DocImpl doc, String key)
Deprecated.Print error message, increment error count.void
error(DocImpl doc, String key, String a1)
Deprecated.Print error message, increment error count.void
error(DocImpl doc, String key, String a1, String a2)
Deprecated.Print error message, increment error count.void
error(DocImpl doc, String key, String a1, String a2, String a3)
Deprecated.Print error message, increment error count.void
exit()
Deprecated.Exit, reporting errors and warnings.AnnotationTypeElementDocImpl
getAnnotationTypeElementDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth)
Deprecated.Return the AnnotationTypeElementDoc for a MethodSymbol.ClassDocImpl
getClassDoc(com.sun.tools.javac.code.Symbol.ClassSymbol clazz)
Deprecated.Return the ClassDoc (or a subtype) of this class symbol.ConstructorDocImpl
getConstructorDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth)
Deprecated.Return the ConstructorDoc for a MethodSymbol.String
getEncoding()
Deprecated.Get the encoding.FieldDocImpl
getFieldDoc(com.sun.tools.javac.code.Symbol.VarSymbol var)
Deprecated.Return the FieldDoc of this var symbol.MethodDocImpl
getMethodDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth)
Deprecated.Return the MethodDoc for a MethodSymbol.PackageDocImpl
getPackageDoc(com.sun.tools.javac.code.Symbol.PackageSymbol pack)
Deprecated.Return the PackageDoc of this package symbol.static DocEnv
instance(com.sun.tools.javac.util.Context context)
Deprecated.protected static boolean
isAnnotationType(com.sun.tools.javac.code.Symbol.ClassSymbol clazz)
Deprecated.protected static boolean
isAnnotationType(com.sun.tools.javac.tree.JCTree.JCClassDecl tree)
Deprecated.protected boolean
isVisible(com.sun.tools.javac.code.Symbol.ClassSymbol sym)
Deprecated.Check the visibility if this is an nested class.ClassDocImpl
loadClass(String name)
Deprecated.Load ClassDoc by qualified name.ClassDocImpl
lookupClass(String name)
Deprecated.Look up ClassDoc by qualified name.PackageDocImpl
lookupPackage(String name)
Deprecated.Look up PackageDoc by qualified name.protected void
makeAnnotationTypeElementDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth, com.sun.source.util.TreePath treePath)
Deprecated.Create the AnnotationTypeElementDoc for a MethodSymbol.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.protected void
makeConstructorDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth, com.sun.source.util.TreePath treePath)
Deprecated.Create the ConstructorDoc for a MethodSymbol.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.protected void
makeMethodDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth, com.sun.source.util.TreePath treePath)
Deprecated.Create a MethodDoc for this MethodSymbol.void
notice(String key)
Deprecated.Print a message.void
notice(String key, String a1)
Deprecated.Print a message.void
notice(String key, String a1, String a2)
Deprecated.Print a message.void
notice(String key, String a1, String a2, String a3)
Deprecated.Print a message.void
printError(SourcePosition pos, String msg)
Deprecated.Print error message, increment error count.void
printError(String msg)
Deprecated.Print error message, increment error count.void
printNotice(SourcePosition pos, String msg)
Deprecated.Print a message.void
printNotice(String msg)
Deprecated.Print a message.void
printWarning(SourcePosition pos, String msg)
Deprecated.Print warning message, increment warning count.void
printWarning(String msg)
Deprecated.Print warning message, increment warning count.void
setEncoding(String encoding)
Deprecated.Set the encoding.void
setLocale(String localeName)
Deprecated.Set the locale.void
setSilent(boolean silent)
Deprecated.boolean
shouldDocument(com.sun.tools.javac.code.Symbol.ClassSymbol sym)
Deprecated.check whether this class should be documented.boolean
shouldDocument(com.sun.tools.javac.code.Symbol.MethodSymbol sym)
Deprecated.Check whether this member should be documented.boolean
shouldDocument(com.sun.tools.javac.code.Symbol.VarSymbol sym)
Deprecated.Check whether this member should be documented.void
warning(DocImpl doc, String key)
Deprecated.Print warning message, increment warning count.void
warning(DocImpl doc, String key, String a1)
Deprecated.Print warning message, increment warning count.void
warning(DocImpl doc, String key, String a1, String a2)
Deprecated.Print warning message, increment warning count.void
warning(DocImpl doc, String key, String a1, String a2, String a3)
Deprecated.Print warning message, increment warning count.void
warning(DocImpl doc, String key, String a1, String a2, String a3, String a4)
Deprecated.Print warning message, increment warning count.
-
-
-
Field Detail
-
XMSGS_OPTION
public static final String XMSGS_OPTION
Deprecated.- See Also:
- Constant Field Values
-
XMSGS_CUSTOM_PREFIX
public static final String XMSGS_CUSTOM_PREFIX
Deprecated.- See Also:
- Constant Field Values
-
XCUSTOM_TAGS_PREFIX
public static final String XCUSTOM_TAGS_PREFIX
Deprecated.- See Also:
- Constant Field Values
-
XCHECK_PACKAGE
public static final String XCHECK_PACKAGE
Deprecated.- See Also:
- Constant Field Values
-
SEPARATOR
public static final String SEPARATOR
Deprecated.- See Also:
- Constant Field Values
-
docEnvKey
protected static final com.sun.tools.javac.util.Context.Key<DocEnv> docEnvKey
Deprecated.
-
showAccess
protected ModifierFilter showAccess
Deprecated.Access filter (public, protected, ...).
-
legacyDoclet
protected boolean legacyDoclet
Deprecated.Does the doclet only expect pre-1.5 doclet API?
-
source
protected com.sun.tools.javac.code.Source source
Deprecated.The source language version.
-
packageMap
protected Map<com.sun.tools.javac.code.Symbol.PackageSymbol,PackageDocImpl> packageMap
Deprecated.
-
classMap
protected Map<com.sun.tools.javac.code.Symbol.ClassSymbol,ClassDocImpl> classMap
Deprecated.
-
fieldMap
protected Map<com.sun.tools.javac.code.Symbol.VarSymbol,FieldDocImpl> fieldMap
Deprecated.
-
methodMap
protected Map<com.sun.tools.javac.code.Symbol.MethodSymbol,ExecutableMemberDocImpl> methodMap
Deprecated.
-
-
Method Detail
-
instance
public static DocEnv instance(com.sun.tools.javac.util.Context context)
Deprecated.
-
setSilent
public void setSilent(boolean silent)
Deprecated.
-
lookupClass
public ClassDocImpl lookupClass(String name)
Deprecated.Look up ClassDoc by qualified name.
-
loadClass
public ClassDocImpl loadClass(String name)
Deprecated.Load ClassDoc by qualified name.
-
lookupPackage
public PackageDocImpl lookupPackage(String name)
Deprecated.Look up PackageDoc by qualified name.
-
setLocale
public void setLocale(String localeName)
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
public void printError(String msg)
Deprecated.Print error message, increment error count.- Parameters:
msg
- message to print.
-
error
public void error(DocImpl doc, String key)
Deprecated.Print error message, increment error count.- Parameters:
key
- selects message from resource
-
error
public void error(SourcePosition pos, String key)
Deprecated.Print error message, increment error count.- Parameters:
key
- selects message from resource
-
printError
public void printError(SourcePosition pos, String msg)
Deprecated.Print error message, increment error count.- Parameters:
msg
- message to print.
-
error
public void error(DocImpl doc, String key, String a1)
Deprecated.Print error message, increment error count.- Parameters:
key
- selects message from resourcea1
- first argument
-
error
public void error(DocImpl doc, String key, String a1, String a2)
Deprecated.Print error message, increment error count.- Parameters:
key
- selects message from resourcea1
- first argumenta2
- second argument
-
error
public void error(DocImpl doc, String key, String a1, String a2, String a3)
Deprecated.Print error message, increment error count.- Parameters:
key
- selects message from resourcea1
- first argumenta2
- second argumenta3
- third argument
-
printWarning
public void printWarning(String msg)
Deprecated.Print warning message, increment warning count.- Parameters:
msg
- message to print.
-
warning
public void warning(DocImpl doc, String key)
Deprecated.Print warning message, increment warning count.- Parameters:
key
- selects message from resource
-
printWarning
public void printWarning(SourcePosition pos, String msg)
Deprecated.Print warning message, increment warning count.- Parameters:
msg
- message to print.
-
warning
public void warning(DocImpl doc, String key, String a1)
Deprecated.Print warning message, increment warning count.- Parameters:
key
- selects message from resourcea1
- first argument
-
warning
public void warning(DocImpl doc, String key, String a1, String a2)
Deprecated.Print warning message, increment warning count.- Parameters:
key
- selects message from resourcea1
- first argumenta2
- second argument
-
warning
public void warning(DocImpl doc, String key, String a1, String a2, String a3)
Deprecated.Print warning message, increment warning count.- Parameters:
key
- selects message from resourcea1
- first argumenta2
- second argumenta3
- third argument
-
warning
public void warning(DocImpl doc, String key, String a1, String a2, String a3, String a4)
Deprecated.Print warning message, increment warning count.- Parameters:
key
- selects message from resourcea1
- first argumenta2
- second argumenta3
- third argument
-
printNotice
public void printNotice(String msg)
Deprecated.Print a message.- Parameters:
msg
- message to print.
-
notice
public void notice(String key)
Deprecated.Print a message.- Parameters:
key
- selects message from resource
-
printNotice
public void printNotice(SourcePosition pos, String msg)
Deprecated.Print a message.- Parameters:
msg
- message to print.
-
notice
public void notice(String key, String a1)
Deprecated.Print a message.- Parameters:
key
- selects message from resourcea1
- first argument
-
notice
public void notice(String key, String a1, String a2)
Deprecated.Print a message.- Parameters:
key
- selects message from resourcea1
- first argumenta2
- second argument
-
notice
public void notice(String key, String a1, String a2, String a3)
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
public PackageDocImpl getPackageDoc(com.sun.tools.javac.code.Symbol.PackageSymbol pack)
Deprecated.Return the PackageDoc of this package symbol.
-
getClassDoc
public ClassDocImpl getClassDoc(com.sun.tools.javac.code.Symbol.ClassSymbol clazz)
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
public FieldDocImpl getFieldDoc(com.sun.tools.javac.code.Symbol.VarSymbol var)
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
public MethodDocImpl getMethodDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth)
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
public ConstructorDocImpl getConstructorDoc(com.sun.tools.javac.code.Symbol.MethodSymbol meth)
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.
-
setEncoding
public void setEncoding(String encoding)
Deprecated.Set the encoding.
-
getEncoding
public String getEncoding()
Deprecated.Get the encoding.
-
-