com.google.javascript.jscomp

Class AbstractCommandLineRunner<A extends Compiler,B extends CompilerOptions>

java.lang.Object

com.google.javascript.jscomp.AbstractCommandLineRunner<A,B>

Direct Known Subclasses:

CommandLineRunner

@GwtIncompatible(value="Unnecessary")
public abstract class AbstractCommandLineRunner<A extends Compiler,B extends CompilerOptions>
extends Object

Implementations of AbstractCommandLineRunner translate flags into Java API calls on the Compiler. AbstractCompiler contains common flags and logic to make that happen. This class may be extended and used to create other Java classes that behave the same as running the Compiler from the command line. Example:

 class MyCommandLineRunner extends
     AbstractCommandLineRunner<MyCompiler, MyOptions> {
   MyCommandLineRunner(String[] args) {
     super(args);
   }

   @Override
   protected MyOptions createOptions() {
     MyOptions options = new MyOptions();
     CompilerFlagTranslator.setOptionsFromFlags(options);
     addMyCrazyCompilerPassThatOutputsAnExtraFile(options);
     return options;
   }

   @Override
   protected MyCompiler createCompiler() {
     return new MyCompiler();
   }

   public static void main(String[] args) {
     (new MyCommandLineRunner(args)).run();
   }
 }
 

Author:

[email protected] (Michael Bolin)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractCommandLineRunner.FlagUsageException An exception thrown when command-line flags are used incorrectly.
protected static class	AbstractCommandLineRunner.WarningGuardSpec A little helper class to make it easier to collect warning types from --jscomp_error, --jscomp_warning, and --jscomp_off.

Method Summary

Modifier and Type	Method and Description
protected abstract void	addWhitelistWarningsGuard(CompilerOptions options, File whitelistFile)
protected void	checkModuleName(String name) Validates the module name.
protected abstract A	createCompiler() Returns the instance of the Compiler to use when run() is called.
protected List<SourceFile>	createExterns(CompilerOptions options)
protected List<SourceFile>	createInputs(List<String> files, boolean allowStdIn) Creates inputs from a list of files.
protected List<SourceFile>	createInputs(List<String> files, List<com.google.javascript.jscomp.AbstractCommandLineRunner.JsonFileSpec> jsonFiles) Creates inputs from a list of source files and json files.
protected List<SourceFile>	createInputs(List<String> files, List<String> zips, boolean allowStdIn) Creates inputs from a list of source files and zips.
protected List<SourceFile>	createInputs(List<String> files, List<String> zips, List<com.google.javascript.jscomp.AbstractCommandLineRunner.JsonFileSpec> jsonFiles, boolean allowStdIn) Creates inputs from a list of source files, zips and json files.
protected abstract B	createOptions() Returns the instance of the Options to use when run() is called.
protected int	doRun() Parses command-line arguments and runs the compiler.
protected OutputStream	filenameToOutputStream(String fileName) Converts a file name into a Outputstream.
static List<SourceFile>	getBuiltinExterns(CompilerOptions options)
protected com.google.javascript.jscomp.AbstractCommandLineRunner.CommandLineConfig	getCommandLineConfig() Get the command line config, so that it can be initialized.
protected A	getCompiler()
protected DiagnosticGroups	getDiagnosticGroups() The warning classes that are available from the command-line.
protected PrintStream	getErrorPrintStream() Returns the PrintStream for writing errors associated with this AbstractCommandLineRunner.
protected boolean	isInTestMode() Returns whether we're in test mode.
List<com.google.javascript.jscomp.AbstractCommandLineRunner.JsonFileSpec>	parseJsonFilesFromInputStream()
void	run() Runs the Compiler and calls System.exit() with the exit status of the compiler.
protected void	setRunOptions(CompilerOptions options) Sets options based on the configurations set flags API.

Methods inherited from class java.lang.Object

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

Method Detail

isInTestMode

protected boolean isInTestMode()

Returns whether we're in test mode.

getCommandLineConfig

protected com.google.javascript.jscomp.AbstractCommandLineRunner.CommandLineConfig getCommandLineConfig()

Get the command line config, so that it can be initialized.

createCompiler

protected abstract A createCompiler()

Returns the instance of the Compiler to use when run() is called.

createOptions

protected abstract B createOptions()

Returns the instance of the Options to use when run() is called. createCompiler() is called before createOptions(), so getCompiler() will not return null when createOptions() is called.

getDiagnosticGroups

protected DiagnosticGroups getDiagnosticGroups()

The warning classes that are available from the command-line.

addWhitelistWarningsGuard

protected abstract void addWhitelistWarningsGuard(CompilerOptions options,
                                                  File whitelistFile)

setRunOptions

protected void setRunOptions(CompilerOptions options)
                      throws AbstractCommandLineRunner.FlagUsageException,
                             IOException

Sets options based on the configurations set flags API. Called during the run() run() method. If you want to ignore the flags API, or interpret flags your own way, then you should override this method.

Throws:

AbstractCommandLineRunner.FlagUsageException

IOException

getCompiler

protected final A getCompiler()

getBuiltinExterns

public static List<SourceFile> getBuiltinExterns(CompilerOptions options)
                                          throws IOException

Returns:

a mutable list

Throws:

IOException

run

public final void run()

Runs the Compiler and calls System.exit() with the exit status of the compiler.

getErrorPrintStream

protected PrintStream getErrorPrintStream()

Returns the PrintStream for writing errors associated with this AbstractCommandLineRunner.

parseJsonFilesFromInputStream

public List<com.google.javascript.jscomp.AbstractCommandLineRunner.JsonFileSpec> parseJsonFilesFromInputStream()
                                                                                                        throws IOException

Throws:

IOException

createInputs

protected List<SourceFile> createInputs(List<String> files,
                                        boolean allowStdIn)
                                 throws AbstractCommandLineRunner.FlagUsageException,
                                        IOException

Creates inputs from a list of files. Can be overridden by subclasses who want to pull files from different places.

Parameters:

files - A list of filenames

allowStdIn - Whether '-' is allowed appear as a filename to represent stdin. If true, '-' is only allowed to appear once.

Returns:

An array of inputs

Throws:

AbstractCommandLineRunner.FlagUsageException

IOException

createInputs

protected List<SourceFile> createInputs(List<String> files,
                                        List<com.google.javascript.jscomp.AbstractCommandLineRunner.JsonFileSpec> jsonFiles)
                                 throws AbstractCommandLineRunner.FlagUsageException,
                                        IOException

Creates inputs from a list of source files and json files. Can be overridden by subclasses who want to pull files from different places.

Parameters:

files - A list of filenames.

jsonFiles - A list of json encoded files.

Returns:

An array of inputs

Throws:

AbstractCommandLineRunner.FlagUsageException

IOException

createInputs

protected List<SourceFile> createInputs(List<String> files,
                                        List<String> zips,
                                        boolean allowStdIn)
                                 throws AbstractCommandLineRunner.FlagUsageException,
                                        IOException

Creates inputs from a list of source files and zips. Can be overridden by subclasses who want to pull files from different places.

Parameters:

files - A list of filenames.

zips - A list of zip filenames.

allowStdIn - Whether '-' is allowed appear as a filename to represent stdin. If true, '-' is only allowed to appear once.

Returns:

An array of inputs

Throws:

AbstractCommandLineRunner.FlagUsageException

IOException

createInputs

protected List<SourceFile> createInputs(List<String> files,
                                        List<String> zips,
                                        List<com.google.javascript.jscomp.AbstractCommandLineRunner.JsonFileSpec> jsonFiles,
                                        boolean allowStdIn)
                                 throws AbstractCommandLineRunner.FlagUsageException,
                                        IOException

Creates inputs from a list of source files, zips and json files. Can be overridden by subclasses who want to pull files from different places.

Parameters:

files - A list of filenames.

zips - A list of zip filenames.

jsonFiles - A list of json encoded files.

allowStdIn - Whether '-' is allowed appear as a filename to represent stdin. If true, '-' is only allowed to appear once.

Returns:

An array of inputs

Throws:

AbstractCommandLineRunner.FlagUsageException

IOException

checkModuleName

protected void checkModuleName(String name)
                        throws AbstractCommandLineRunner.FlagUsageException

Validates the module name. Can be overridden by subclasses.

Parameters:

name - The module name

Throws:

AbstractCommandLineRunner.FlagUsageException - if the validation fails

doRun

protected int doRun()
             throws AbstractCommandLineRunner.FlagUsageException,
                    IOException

Parses command-line arguments and runs the compiler.

Returns:

system exit status

Throws:

AbstractCommandLineRunner.FlagUsageException

IOException

createExterns

protected List<SourceFile> createExterns(CompilerOptions options)
                                  throws AbstractCommandLineRunner.FlagUsageException,
                                         IOException

Throws:

AbstractCommandLineRunner.FlagUsageException

IOException

filenameToOutputStream

protected OutputStream filenameToOutputStream(String fileName)
                                       throws IOException

Converts a file name into a Outputstream. Returns null if the file name is null.

Throws:

IOException