| java.lang.Object
 com.sun.tools.javadoc.DocEnv
| DocEnv | | public class DocEnv (Code) | | 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.
since:
1.4
author:
Robert Field
author:
Neal Gafter (rewrite)
author:
Scott Seligman (generics) |
| Method Summary | |
| public void | error(DocImpl doc, String key)
Print error message, increment error count. | | public void | error(SourcePosition pos, String key)
Print error message, increment error count. | | public void | error(DocImpl doc, String key, String a1)
Print error message, increment error count. | | public void | error(DocImpl doc, String key, String a1, String a2)
Print error message, increment error count. | | public void | error(DocImpl doc, String key, String a1, String a2, String a3)
Print error message, increment error count. | | public void | exit()
Exit, reporting errors and warnings. | | public AnnotationTypeElementDocImpl | getAnnotationTypeElementDoc(MethodSymbol meth)
Return the AnnotationTypeElementDoc for a MethodSymbol. | | ClassDocImpl | getClassDoc(ClassSymbol clazz)
Return the ClassDoc (or a subtype) of this class symbol. | | ClassSymbol | getClassSymbol(String name)
Retrieve class symbol by fully-qualified name. | | public ConstructorDocImpl | getConstructorDoc(MethodSymbol meth)
Return the ConstructorDoc for a MethodSymbol. | | public String | getEncoding()
Get the encoding. | | FieldDocImpl | getFieldDoc(VarSymbol var)
Return the FieldDoc of this var symbol. | | public MethodDocImpl | getMethodDoc(MethodSymbol meth)
Return the MethodDoc for a MethodSymbol. | | public PackageDocImpl | getPackageDoc(PackageSymbol pack)
Return the PackageDoc of this package symbol. | | ParameterizedTypeImpl | getParameterizedType(ClassType t)
Return the ParameterizedType of this instantiation. | | public static DocEnv | instance(Context context)
| | protected boolean | isVisible(ClassSymbol sym)
Check the visibility if this is an nested class. | | public ClassDocImpl | loadClass(String name)
Load ClassDoc by qualified name. | | public ClassDocImpl | lookupClass(String name)
Look up ClassDoc by qualified name. | | public PackageDocImpl | lookupPackage(String name)
Look up PackageDoc by qualified name. | | void | makeAnnotationTypeElementDoc(MethodSymbol meth, String docComment, JCMethodDecl tree, Position.LineMap lineMap)
Create the AnnotationTypeElementDoc for a MethodSymbol. | | void | makeClassDoc(ClassSymbol clazz, String docComment, JCClassDecl tree, Position.LineMap lineMap)
Create the ClassDoc (or a subtype) for a class symbol. | | void | makeConstructorDoc(MethodSymbol meth, String docComment, JCMethodDecl tree, Position.LineMap lineMap)
Create the ConstructorDoc for a MethodSymbol. | | void | makeFieldDoc(VarSymbol var, String docComment, JCVariableDecl tree, Position.LineMap lineMap)
Create a FieldDoc for a var symbol. | | void | makeMethodDoc(MethodSymbol meth, String docComment, JCMethodDecl tree, Position.LineMap lineMap)
Create a MethodDoc for this MethodSymbol. | | void | makePackageDoc(PackageSymbol pack, String docComment, JCCompilationUnit tree)
Create the PackageDoc (or a subtype) for a package symbol. | | public void | notice(String key)
Print a message. | | public void | notice(String key, String a1)
Print a message. | | public void | notice(String key, String a1, String a2)
Print a message. | | public void | notice(String key, String a1, String a2, String a3)
Print a message. | | public void | printError(String msg)
Print error message, increment error count. | | public void | printError(SourcePosition pos, String msg)
Print error message, increment error count. | | public void | printNotice(String msg)
Print a message. | | public void | printNotice(SourcePosition pos, String msg)
Print a message. | | public void | printWarning(String msg)
Print warning message, increment warning count. | | public void | printWarning(SourcePosition pos, String msg)
Print warning message, increment warning count. | | public void | setEncoding(String encoding)
Set the encoding. | | public void | setLocale(String localeName)
Set the locale. | | public void | setSilent(boolean silent)
| | public boolean | shouldDocument(VarSymbol sym)
Check whether this member should be documented. | | public boolean | shouldDocument(MethodSymbol sym)
Check whether this member should be documented. | | public boolean | shouldDocument(ClassSymbol sym)
check whether this class should be documented. | | static int | translateModifiers(long flags)
Convert modifier bits from private coding used by
the compiler to that of java.lang.reflect.Modifier. | | public void | warning(DocImpl doc, String key)
Print warning message, increment warning count. | | public void | warning(DocImpl doc, String key, String a1)
Print warning message, increment warning count. | | public void | warning(DocImpl doc, String key, String a1, String a2)
Print warning message, increment warning count. | | public void | warning(DocImpl doc, String key, String a1, String a2, String a3)
Print warning message, increment warning count. | | public void | warning(DocImpl doc, String key, String a1, String a2, String a3, String a4)
Print warning message, increment warning count. |
| attr | | Attr attr(Code) | | The compiler's attribution phase (needed to evaluate
constant initializers).
|
| breakiterator | | boolean breakiterator(Code) | | True if we are using a sentence BreakIterator.
|
| docClasses | | boolean docClasses(Code) | | Allow documenting from class files?
|
| legacyDoclet | | boolean legacyDoclet(Code) | | Does the doclet only expect pre-1.5 doclet API?
|
| quiet | | boolean quiet(Code) | | True if we do not want to print any notifications at all.
|
| syms | | Symtab syms(Code) | | Predefined symbols known to the compiler.
|
| error | | public void error(DocImpl doc, String key)(Code) | | Print error message, increment error count.
Parameters:
key - selects message from resource |
| error | | public void error(SourcePosition pos, String key)(Code) | | Print error message, increment error count.
Parameters:
key - selects message from resource |
| error | | public void error(DocImpl doc, String key, String a1)(Code) | | Print error message, increment error count.
Parameters:
key - selects message from resource
Parameters:
a1 - first argument |
| error | | public void error(DocImpl doc, String key, String a1, String a2)(Code) | | Print error message, increment error count.
Parameters:
key - selects message from resource
Parameters:
a1 - first argument
Parameters:
a2 - second argument |
| error | | public void error(DocImpl doc, String key, String a1, String a2, String a3)(Code) | | Print error message, increment error count.
Parameters:
key - selects message from resource
Parameters:
a1 - first argument
Parameters:
a2 - second argument
Parameters:
a3 - third argument |
| exit | | public void exit()(Code) | | Exit, reporting errors and warnings.
|
| getAnnotationTypeElementDoc | | public AnnotationTypeElementDocImpl getAnnotationTypeElementDoc(MethodSymbol meth)(Code) | | Return the AnnotationTypeElementDoc for a MethodSymbol.
Should be called only on symbols representing annotation type elements.
|
| getClassDoc | | ClassDocImpl getClassDoc(ClassSymbol clazz)(Code) | | Return the ClassDoc (or a subtype) of this class symbol.
|
| getClassSymbol | | ClassSymbol getClassSymbol(String name)(Code) | | Retrieve class symbol by fully-qualified name.
|
| getConstructorDoc | | public ConstructorDocImpl getConstructorDoc(MethodSymbol meth)(Code) | | Return the ConstructorDoc for a MethodSymbol.
Should be called only on symbols representing constructors.
|
| getEncoding | | public String getEncoding()(Code) | | Get the encoding.
|
| getFieldDoc | | FieldDocImpl getFieldDoc(VarSymbol var)(Code) | | Return the FieldDoc of this var symbol.
|
| getMethodDoc | | public MethodDocImpl getMethodDoc(MethodSymbol meth)(Code) | | Return the MethodDoc for a MethodSymbol.
Should be called only on symbols representing methods.
|
| getPackageDoc | | public PackageDocImpl getPackageDoc(PackageSymbol pack)(Code) | | Return the PackageDoc of this package symbol.
|
| getParameterizedType | | ParameterizedTypeImpl getParameterizedType(ClassType t)(Code) | | Return the ParameterizedType of this instantiation.
// * ### Could use Type.sameTypeAs() instead of equality matching in hashmap
// * ### to avoid some duplication.
|
| isVisible | | protected boolean isVisible(ClassSymbol sym)(Code) | | 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.
|
| makeAnnotationTypeElementDoc | | void makeAnnotationTypeElementDoc(MethodSymbol meth, String docComment, JCMethodDecl tree, Position.LineMap lineMap)(Code) | | Create the AnnotationTypeElementDoc for a MethodSymbol.
Should be called only on symbols representing annotation type elements.
|
| makeClassDoc | | void makeClassDoc(ClassSymbol clazz, String docComment, JCClassDecl tree, Position.LineMap lineMap)(Code) | | Create the ClassDoc (or a subtype) for a class symbol.
|
| makeConstructorDoc | | void makeConstructorDoc(MethodSymbol meth, String docComment, JCMethodDecl tree, Position.LineMap lineMap)(Code) | | Create the ConstructorDoc for a MethodSymbol.
Should be called only on symbols representing constructors.
|
| makeFieldDoc | | void makeFieldDoc(VarSymbol var, String docComment, JCVariableDecl tree, Position.LineMap lineMap)(Code) | | Create a FieldDoc for a var symbol.
|
| makeMethodDoc | | void makeMethodDoc(MethodSymbol meth, String docComment, JCMethodDecl tree, Position.LineMap lineMap)(Code) | | Create a MethodDoc for this MethodSymbol.
Should be called only on symbols representing methods.
|
| makePackageDoc | | void makePackageDoc(PackageSymbol pack, String docComment, JCCompilationUnit tree)(Code) | | Create the PackageDoc (or a subtype) for a package symbol.
|
| notice | | public void notice(String key)(Code) | | Print a message.
Parameters:
key - selects message from resource |
| notice | | public void notice(String key, String a1)(Code) | | Print a message.
Parameters:
key - selects message from resource
Parameters:
a1 - first argument |
| notice | | public void notice(String key, String a1, String a2)(Code) | | Print a message.
Parameters:
key - selects message from resource
Parameters:
a1 - first argument
Parameters:
a2 - second argument |
| notice | | public void notice(String key, String a1, String a2, String a3)(Code) | | Print a message.
Parameters:
key - selects message from resource
Parameters:
a1 - first argument
Parameters:
a2 - second argument
Parameters:
a3 - third argument |
| printError | | public void printError(String msg)(Code) | | Print error message, increment error count.
Parameters:
msg - message to print. |
| printError | | public void printError(SourcePosition pos, String msg)(Code) | | Print error message, increment error count.
Parameters:
msg - message to print. |
| printNotice | | public void printNotice(String msg)(Code) | | Print a message.
Parameters:
msg - message to print. |
| printNotice | | public void printNotice(SourcePosition pos, String msg)(Code) | | Print a message.
Parameters:
msg - message to print. |
| printWarning | | public void printWarning(String msg)(Code) | | Print warning message, increment warning count.
Parameters:
msg - message to print. |
| printWarning | | public void printWarning(SourcePosition pos, String msg)(Code) | | Print warning message, increment warning count.
Parameters:
msg - message to print. |
| setEncoding | | public void setEncoding(String encoding)(Code) | | Set the encoding.
|
| setLocale | | public void setLocale(String localeName)(Code) | | Set the locale.
|
| setSilent | | public void setSilent(boolean silent)(Code) | | |
| shouldDocument | | public boolean shouldDocument(VarSymbol sym)(Code) | | Check whether this member should be documented.
|
| shouldDocument | | public boolean shouldDocument(MethodSymbol sym)(Code) | | Check whether this member should be documented.
|
| shouldDocument | | public boolean shouldDocument(ClassSymbol sym)(Code) | | check whether this class should be documented.
|
| translateModifiers | | static int translateModifiers(long flags)(Code) | | Convert modifier bits from private coding used by
the compiler to that of java.lang.reflect.Modifier.
|
| warning | | public void warning(DocImpl doc, String key)(Code) | | Print warning message, increment warning count.
Parameters:
key - selects message from resource |
| warning | | public void warning(DocImpl doc, String key, String a1)(Code) | | Print warning message, increment warning count.
Parameters:
key - selects message from resource
Parameters:
a1 - first argument |
| warning | | public void warning(DocImpl doc, String key, String a1, String a2)(Code) | | Print warning message, increment warning count.
Parameters:
key - selects message from resource
Parameters:
a1 - first argument
Parameters:
a2 - second argument |
| warning | | public void warning(DocImpl doc, String key, String a1, String a2, String a3)(Code) | | Print warning message, increment warning count.
Parameters:
key - selects message from resource
Parameters:
a1 - first argument
Parameters:
a2 - second argument
Parameters:
a3 - third argument |
| warning | | public void warning(DocImpl doc, String key, String a1, String a2, String a3, String a4)(Code) | | Print warning message, increment warning count.
Parameters:
key - selects message from resource
Parameters:
a1 - first argument
Parameters:
a2 - second argument
Parameters:
a3 - third argument |
|
|