public interface

Generator

sun.rmi.rmic.newrmic.Generator
Known Indirect Subclasses

Class Overview

The interface to rmic back end implementations. Classes that implement this interface correspond to the various generation modes of rmic (JRMP, IIOP, IDL, etc.). A Generator instance corresponds to a particular rmic compilation batch, and its instance state represents the generator-specific command line options for that batch. Main will instantiate a generator class when the command line arguments indicate selection of the corresponding generation mode. Main will then invoke the "parseArgs" method to allow the generator to process any generator-specific command line options and set its instance state accordingly. 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 Methods
abstract Set<String> bootstrapClassNames()
Returns the names of the classes that must be available through the doclet API in order for this generator to function.
abstract Class<? extends BatchEnvironment> envClass()
Returns the most specific environment class required by this generator.
abstract void generate(BatchEnvironment env, ClassDoc inputClass, File destDir)
Generates the protocol-specific rmic output files for the specified remote class.
abstract boolean parseArgs(String[] args, Main main)
Processes the command line options specific to this generator.

Public Methods

public abstract Set<String> bootstrapClassNames ()

Returns the names of the classes that must be available through the doclet API in order for this generator to function.

public abstract Class<? extends BatchEnvironment> envClass ()

Returns the most specific environment class required by this generator.

public abstract void generate (BatchEnvironment env, ClassDoc inputClass, File destDir)

Generates the protocol-specific rmic output files for the specified remote class. This method is invoked once for each class or interface specified on the command line for the rmic compilation batch associated with this instance. Any generated source files (to be compiled with javac) are passed to the addGeneratedFile method of the specified BatchEnvironment.

public abstract boolean parseArgs (String[] args, Main main)

Processes the command line options specific to this generator. Processed options are set to null in the specified array. Returns true if successful or false if an error occurs. Errors are output to the specific Main instance.