com.sun.tools.javadoc
Class Start

java.lang.Object
  com.sun.tools.javadoc.Start

 class Start
extends java.lang.Object

Main program of Javadoc. Previously named "Main".

Since:

1.2

Field Summary

(package private) boolean	breakiterator
private Context	context Context for this invocation.
private java.lang.String	defaultDocletClassName
private long	defaultFilter
private DocletInvoker	docletInvoker
private java.lang.ClassLoader	docletParentClassLoader
(package private) java.lang.String	docLocale
(package private) java.lang.String	encoding
private static int	F_VERBOSE
private static int	F_WARNINGS
private static java.lang.String	javadocName
private Messager	messager
private ListBuffer<java.lang.String[]>	options
(package private) boolean	quiet
private boolean	rejectWarnings
private ModifierFilter	showAccess
private static java.lang.String	standardDocletClassName

Constructor Summary

Start()

Start(java.lang.ClassLoader docletParentClassLoader)

Start(java.lang.String programName)

Start(java.lang.String programName, java.lang.ClassLoader docletParentClassLoader)

Start(java.lang.String programName, java.io.PrintWriter errWriter, java.io.PrintWriter warnWriter, java.io.PrintWriter noticeWriter, java.lang.String defaultDocletClassName)

Start(java.lang.String programName, java.io.PrintWriter errWriter, java.io.PrintWriter warnWriter, java.io.PrintWriter noticeWriter, java.lang.String defaultDocletClassName, java.lang.ClassLoader docletParentClassLoader)

Start(java.lang.String programName, java.lang.String defaultDocletClassName)

Start(java.lang.String programName, java.lang.String defaultDocletClassName, java.lang.ClassLoader docletParentClassLoader)

Method Summary

private void	addToList(ListBuffer<java.lang.String> list, java.lang.String str)
(package private) int	begin(java.lang.String... argv) Main program - external wrapper
private void	exit() Exit
private void	oneArg(java.lang.String[] args, int index) Set one arg option.
private boolean	parseAndExecute(java.lang.String... argv) Main program - internal
private void	setDocletInvoker(java.lang.String[] argv)
private void	setFilter(long filterBits)
private void	setOption(java.lang.String opt) indicate an option with no arguments was given.
private void	setOption(java.lang.String opt, List<java.lang.String> arguments) indicate an option with the specified list of arguments was given.
private void	setOption(java.lang.String opt, java.lang.String argument) indicate an option with one argument was given.
private void	usage() Usage
private void	usageError(java.lang.String key)
private void	usageError(java.lang.String key, java.lang.String a1)
private void	usageError(java.lang.String key, java.lang.String a1, java.lang.String a2)

Methods inherited from class java.lang.Object

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

Field Detail

context

private final Context context

Context for this invocation.

defaultDocletClassName

private final java.lang.String defaultDocletClassName

docletParentClassLoader

private final java.lang.ClassLoader docletParentClassLoader

javadocName

private static final java.lang.String javadocName

See Also:

Constant Field Values

standardDocletClassName

private static final java.lang.String standardDocletClassName

See Also:

Constant Field Values

options

private ListBuffer<java.lang.String[]> options

showAccess

private ModifierFilter showAccess

defaultFilter

private long defaultFilter

messager

private Messager messager

docLocale

java.lang.String docLocale

breakiterator

boolean breakiterator

quiet

boolean quiet

encoding

java.lang.String encoding

docletInvoker

private DocletInvoker docletInvoker

F_VERBOSE

private static final int F_VERBOSE

See Also:

Constant Field Values

F_WARNINGS

private static final int F_WARNINGS

See Also:

Constant Field Values

rejectWarnings

private boolean rejectWarnings

Constructor Detail

Start

Start(java.lang.String programName,
      java.io.PrintWriter errWriter,
      java.io.PrintWriter warnWriter,
      java.io.PrintWriter noticeWriter,
      java.lang.String defaultDocletClassName)

Start

Start(java.lang.String programName,
      java.io.PrintWriter errWriter,
      java.io.PrintWriter warnWriter,
      java.io.PrintWriter noticeWriter,
      java.lang.String defaultDocletClassName,
      java.lang.ClassLoader docletParentClassLoader)

Start

Start(java.lang.String programName,
      java.lang.String defaultDocletClassName)

Start

Start(java.lang.String programName,
      java.lang.String defaultDocletClassName,
      java.lang.ClassLoader docletParentClassLoader)

Start

Start(java.lang.String programName,
      java.lang.ClassLoader docletParentClassLoader)

Start

Start(java.lang.String programName)

Start

Start(java.lang.ClassLoader docletParentClassLoader)

Start

Start()

Method Detail

usage

private void usage()

Usage

exit

private void exit()

Exit

begin

int begin(java.lang.String... argv)

Main program - external wrapper

addToList

private void addToList(ListBuffer<java.lang.String> list,
                       java.lang.String str)

parseAndExecute

private boolean parseAndExecute(java.lang.String... argv)
                         throws java.io.IOException

Main program - internal

Throws:

java.io.IOException

setDocletInvoker

private void setDocletInvoker(java.lang.String[] argv)

setFilter

private void setFilter(long filterBits)

oneArg

private void oneArg(java.lang.String[] args,
                    int index)

Set one arg option. Error and exit if one argument is not provided.

usageError

private void usageError(java.lang.String key)

usageError

private void usageError(java.lang.String key,
                        java.lang.String a1)

usageError

private void usageError(java.lang.String key,
                        java.lang.String a1,
                        java.lang.String a2)

setOption

private void setOption(java.lang.String opt)

indicate an option with no arguments was given.

setOption

private void setOption(java.lang.String opt,
                       java.lang.String argument)

indicate an option with one argument was given.

setOption

private void setOption(java.lang.String opt,
                       List<java.lang.String> arguments)

indicate an option with the specified list of arguments was given.