Package gw.gosudoc.com.sun.tools.javadoc.main

Class RootDocImpl

java.lang.Object

gw.gosudoc.com.sun.tools.javadoc.main.DocImpl

gw.gosudoc.com.sun.tools.javadoc.main.RootDocImpl

All Implemented Interfaces:

Doc, DocErrorReporter, RootDoc, Comparable<Object>

@Deprecated
public class RootDocImpl
extends DocImpl
implements RootDoc

Deprecated.

This class holds the information from one run of javadoc. Particularly the packages, classes and options specified by the user.

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.2

Author:

Robert Field, Atul M Dambalkar, Neal Gafter (rewrite)

Field Summary

Fields inherited from class gw.gosudoc.com.sun.tools.javadoc.main.DocImpl

documentation, env, treePath

Constructor Summary

Constructors

Constructor	Description
RootDocImpl(DocEnv env, com.sun.tools.javac.util.List<com.sun.tools.javac.tree.JCTree.JCClassDecl> classes, com.sun.tools.javac.util.List<String> packages, com.sun.tools.javac.util.List<String[]> options)	Deprecated. Constructor used when reading source files.
RootDocImpl(DocEnv env, com.sun.tools.javac.util.List<String> classes, com.sun.tools.javac.util.List<String[]> options)	Deprecated. Constructor used when reading class files.

Method Summary

Modifier and Type	Method	Description
ClassDoc[]	classes()	Deprecated. Return all classes and interfaces (including those inside packages) to be documented.
ClassDoc	classNamed(String qualifiedName)	Deprecated. Return a ClassDoc for the specified class/interface name
protected String	documentation()	Deprecated. Do lazy initialization of "documentation" string.
JavaFileManager	getFileManager()	Deprecated. Return the current file manager.
Locale	getLocale()	Deprecated. Return the locale provided by the user or the default locale value.
void	initDocLint(Collection<String> opts, Collection<String> customTagNames, String htmlVersion)	Deprecated.
JavaScriptScanner	initJavaScriptScanner(boolean allowScriptInComments)	Deprecated.
boolean	isFunctionalInterface(AnnotationDesc annotationDesc)	Deprecated.
boolean	isIncluded()	Deprecated. Return true if this Doc is include in the active set.
String	name()	Deprecated. Return the name of this Doc item.
String[][]	options()	Deprecated. Command line options.
PackageDoc	packageNamed(String name)	Deprecated. Return a PackageDoc for the specified package name
SourcePosition	position()	Deprecated. Return the source position of the entity, or null if no position is available.
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.
String	qualifiedName()	Deprecated. Return the name of this Doc item.
boolean	showTagMessages()	Deprecated.
ClassDoc[]	specifiedClasses()	Deprecated. Classes and interfaces specified on the command line.
PackageDoc[]	specifiedPackages()	Deprecated. Packages specified on the command line.

Methods inherited from class gw.gosudoc.com.sun.tools.javadoc.main.DocImpl

commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isInterface, isMethod, isOrdinaryClass, seeTags, setRawCommentText, tags, tags, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface gw.gosudoc.com.sun.javadoc.Doc

commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isInterface, isMethod, isOrdinaryClass, seeTags, setRawCommentText, tags, tags

Constructor Detail

RootDocImpl

public RootDocImpl(DocEnv env,
                   com.sun.tools.javac.util.List<com.sun.tools.javac.tree.JCTree.JCClassDecl> classes,
                   com.sun.tools.javac.util.List<String> packages,
                   com.sun.tools.javac.util.List<String[]> options)

Deprecated.

Constructor used when reading source files.

Parameters:

env - the documentation environment, state for this javadoc run

classes - list of classes specified on the commandline

packages - list of package names specified on the commandline

options - list of options

RootDocImpl

public RootDocImpl(DocEnv env,
                   com.sun.tools.javac.util.List<String> classes,
                   com.sun.tools.javac.util.List<String[]> options)

Deprecated.

Constructor used when reading class files.

Parameters:

env - the documentation environment, state for this javadoc run

classes - list of class names specified on the commandline

options - list of options

Method Detail

options

public String[][] options()

Deprecated.

Command line options.

 For example, given:
     javadoc -foo this that -bar other ...

 This method will return:
      options()[0][0] = "-foo"
      options()[0][1] = "this"
      options()[0][2] = "that"
      options()[1][0] = "-bar"
      options()[1][1] = "other"
 

Specified by:

options in interface RootDoc

Returns:

an array of arrays of String.

specifiedPackages

public PackageDoc[] specifiedPackages()

Deprecated.

Packages specified on the command line.

Specified by:

specifiedPackages in interface RootDoc

Returns:

packages specified on the command line.

specifiedClasses

public ClassDoc[] specifiedClasses()

Deprecated.

Classes and interfaces specified on the command line.

Specified by:

specifiedClasses in interface RootDoc

Returns:

classes and interfaces specified on the command line.

classes

public ClassDoc[] classes()

Deprecated.

Return all classes and interfaces (including those inside packages) to be documented.

Specified by:

classes in interface RootDoc

Returns:

included classes and interfaces in all packages.

classNamed

public ClassDoc classNamed(String qualifiedName)

Deprecated.

Return a ClassDoc for the specified class/interface name

Specified by:

classNamed in interface RootDoc

Parameters:

qualifiedName - qualified class name (i.e. includes package name).

Returns:

a ClassDocImpl holding the specified class, null if this class is not referenced.

packageNamed

public PackageDoc packageNamed(String name)

Deprecated.

Return a PackageDoc for the specified package name

Specified by:

packageNamed in interface RootDoc

Parameters:

name - package name

Returns:

a PackageDoc holding the specified package, null if this package is not referenced.

name

public String name()

Deprecated.

Return the name of this Doc item.

Specified by:

name in interface Doc

Specified by:

name in class DocImpl

Returns:

the string "*RootDocImpl*".

qualifiedName

public String qualifiedName()

Deprecated.

Return the name of this Doc item.

Specified by:

qualifiedName in class DocImpl

Returns:

the string "*RootDocImpl*".

isIncluded

public boolean isIncluded()

Deprecated.

Return true if this Doc is include in the active set. RootDocImpl isn't even a program entity so it is always false.

Specified by:

isIncluded in interface Doc

Specified by:

isIncluded in class DocImpl

Returns:

true if this Doc item is included in the result set.

printError

public void printError(String msg)

Deprecated.

Print error message, increment error count.

Specified by:

printError in interface DocErrorReporter

Parameters:

msg - message to print

printError

public void printError(SourcePosition pos,
                       String msg)

Deprecated.

Print error message, increment error count.

Specified by:

printError in interface DocErrorReporter

Parameters:

msg - message to print

pos - the position item where the error occurs

printWarning

public void printWarning(String msg)

Deprecated.

Print warning message, increment warning count.

Specified by:

printWarning in interface DocErrorReporter

Parameters:

msg - message to print

printWarning

public void printWarning(SourcePosition pos,
                         String msg)

Deprecated.

Print warning message, increment warning count.

Specified by:

printWarning in interface DocErrorReporter

Parameters:

msg - message to print

pos - the position item where the warning occurs

printNotice

public void printNotice(String msg)

Deprecated.

Print a message.

Specified by:

printNotice in interface DocErrorReporter

Parameters:

msg - message to print

printNotice

public void printNotice(SourcePosition pos,
                        String msg)

Deprecated.

Print a message.

Specified by:

printNotice in interface DocErrorReporter

Parameters:

msg - message to print

pos - the position item where the message occurs

documentation

protected String documentation()

Deprecated.

Do lazy initialization of "documentation" string.

Overrides:

documentation in class DocImpl

position

public SourcePosition position()

Deprecated.

Return the source position of the entity, or null if no position is available.

Specified by:

position in interface Doc

Overrides:

position in class DocImpl

Returns:

the source positino of the first line of the corresponding declaration, or null if no position is available. A default constructor returns null because it has no location in the source file.

getLocale

public Locale getLocale()

Deprecated.

Return the locale provided by the user or the default locale value.

getFileManager

public JavaFileManager getFileManager()

Deprecated.

Return the current file manager.

initDocLint

public void initDocLint(Collection<String> opts,
                        Collection<String> customTagNames,
                        String htmlVersion)

Deprecated.

initJavaScriptScanner

public JavaScriptScanner initJavaScriptScanner(boolean allowScriptInComments)

Deprecated.

isFunctionalInterface

public boolean isFunctionalInterface(AnnotationDesc annotationDesc)

Deprecated.

showTagMessages

public boolean showTagMessages()

Deprecated.