public class

BatchEnvironment

extends Object
java.lang.Object
   ↳ sun.rmi.rmic.newrmic.BatchEnvironment

Class Overview

The environment for an rmic compilation batch. A BatchEnvironment contains a RootDoc, which is the entry point into the doclet environment for the associated rmic compilation batch. A BatchEnvironment collects the source files generated during the batch's execution, for eventual source code compilation and, possibly, deletion. Errors that occur during generation activity should be reported through the BatchEnvironment's "error" method. A protocol-specific generator class may require the use of a particular BatchEnvironment subclass for enhanced environment functionality. A BatchEnvironment subclass must declare a public constructor with one parameter of type RootDoc. WARNING: The contents of this source file are not part of any supported API. Code that depends on them does so at its own risk: they are subject to change or removal without notice.

Summary

Public Constructors
BatchEnvironment(RootDoc rootDoc)
Creates a new BatchEnvironment with the specified RootDoc.
Public Methods
void addGeneratedFile(File file)
Adds the specified file to the list of source files generated during this batch.
ClassDoc docException()
ClassDoc docRemote()
ClassDoc docRemoteException()
ClassDoc docRuntimeException()
void error(String key, String... args)
Reports an error using the specified resource key and text formatting arguments.
List<File> generatedFiles()
Returns the list of files generated during this batch.
void output(String msg)
Outputs the specified (non-error) message.
RootDoc rootDoc()
Returns the RootDoc for this environment.
void setVerbose(boolean verbose)
Sets this environment's verbosity status.
boolean verbose()
Returns this environment's verbosity status.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public BatchEnvironment (RootDoc rootDoc)

Creates a new BatchEnvironment with the specified RootDoc.

Public Methods

public void addGeneratedFile (File file)

Adds the specified file to the list of source files generated during this batch.

public ClassDoc docException ()

public ClassDoc docRemote ()

public ClassDoc docRemoteException ()

public ClassDoc docRuntimeException ()

public void error (String key, String... args)

Reports an error using the specified resource key and text formatting arguments.

public List<File> generatedFiles ()

Returns the list of files generated during this batch.

public void output (String msg)

Outputs the specified (non-error) message.

public RootDoc rootDoc ()

Returns the RootDoc for this environment.

public void setVerbose (boolean verbose)

Sets this environment's verbosity status.

public boolean verbose ()

Returns this environment's verbosity status.