com.sun.tools.javadoc
Class Main

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

public class Main
extends java.lang.Object

Provides external entry points (tool and programmatic) for the javadoc program.

Since:

1.4

Constructor Summary

private

Main() Constructor should never be called.

Method Summary

static int	execute(java.lang.ClassLoader docletParentClassLoader, java.lang.String... args) Programmatic interface.
static int	execute(java.lang.String... args) Programmatic interface.
static int	execute(java.lang.String programName, java.lang.ClassLoader docletParentClassLoader, java.lang.String... args) Programmatic interface.
static int	execute(java.lang.String programName, java.io.PrintWriter errWriter, java.io.PrintWriter warnWriter, java.io.PrintWriter noticeWriter, java.lang.String defaultDocletClassName, java.lang.ClassLoader docletParentClassLoader, java.lang.String... args) Programmatic interface.
static int	execute(java.lang.String programName, java.io.PrintWriter errWriter, java.io.PrintWriter warnWriter, java.io.PrintWriter noticeWriter, java.lang.String defaultDocletClassName, java.lang.String... args) Programmatic interface.
static int	execute(java.lang.String programName, java.lang.String... args) Programmatic interface.
static int	execute(java.lang.String programName, java.lang.String defaultDocletClassName, java.lang.ClassLoader docletParentClassLoader, java.lang.String... args) Programmatic interface.
static int	execute(java.lang.String programName, java.lang.String defaultDocletClassName, java.lang.String... args) Programmatic interface.
static void	main(java.lang.String... args) Command line interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

Main

private Main()

Constructor should never be called.

Method Detail

main

public static void main(java.lang.String... args)

Command line interface.

Parameters:

args - The command line parameters.

execute

public static int execute(java.lang.String... args)

Programmatic interface.

Parameters:

args - The command line parameters.

Returns:

The return code.

execute

public static int execute(java.lang.ClassLoader docletParentClassLoader,
                          java.lang.String... args)

Programmatic interface.

Parameters:

args - The command line parameters.

docletParentClassLoader - The parent class loader used when creating the doclet classloader. If null, the class loader used to instantiate doclets will be created without specifying a parent class loader.

Returns:

The return code.

Since:

1.7

execute

public static int execute(java.lang.String programName,
                          java.lang.String... args)

Programmatic interface.

Parameters:

programName - Name of the program (for error messages).

args - The command line parameters.

Returns:

The return code.

execute

public static int execute(java.lang.String programName,
                          java.lang.ClassLoader docletParentClassLoader,
                          java.lang.String... args)

Programmatic interface.

Parameters:

programName - Name of the program (for error messages).

args - The command line parameters.

docletParentClassLoader - The parent class loader used when creating the doclet classloader. If null, the class loader used to instantiate doclets will be created without specifying a parent class loader.

Returns:

The return code.

Since:

1.7

execute

public static int execute(java.lang.String programName,
                          java.lang.String defaultDocletClassName,
                          java.lang.String... args)

Programmatic interface.

Parameters:

programName - Name of the program (for error messages).

defaultDocletClassName - Fully qualified class name.

args - The command line parameters.

Returns:

The return code.

execute

public static int execute(java.lang.String programName,
                          java.lang.String defaultDocletClassName,
                          java.lang.ClassLoader docletParentClassLoader,
                          java.lang.String... args)

Programmatic interface.

Parameters:

programName - Name of the program (for error messages).

defaultDocletClassName - Fully qualified class name.

docletParentClassLoader - The parent class loader used when creating the doclet classloader. If null, the class loader used to instantiate doclets will be created without specifying a parent class loader.

args - The command line parameters.

Returns:

The return code.

Since:

1.7

execute

public static int execute(java.lang.String programName,
                          java.io.PrintWriter errWriter,
                          java.io.PrintWriter warnWriter,
                          java.io.PrintWriter noticeWriter,
                          java.lang.String defaultDocletClassName,
                          java.lang.String... args)

Programmatic interface.

Parameters:

programName - Name of the program (for error messages).

errWriter - PrintWriter to receive error messages.

warnWriter - PrintWriter to receive error messages.

noticeWriter - PrintWriter to receive error messages.

defaultDocletClassName - Fully qualified class name.

args - The command line parameters.

Returns:

The return code.

execute

public static int execute(java.lang.String programName,
                          java.io.PrintWriter errWriter,
                          java.io.PrintWriter warnWriter,
                          java.io.PrintWriter noticeWriter,
                          java.lang.String defaultDocletClassName,
                          java.lang.ClassLoader docletParentClassLoader,
                          java.lang.String... args)

Programmatic interface.

Parameters:

programName - Name of the program (for error messages).

errWriter - PrintWriter to receive error messages.

warnWriter - PrintWriter to receive error messages.

noticeWriter - PrintWriter to receive error messages.

defaultDocletClassName - Fully qualified class name.

docletParentClassLoader - The parent class loader used when creating the doclet classloader. If null, the class loader used to instantiate doclets will be created without specifying a parent class loader.

args - The command line parameters.

Returns:

The return code.

Since:

1.7