AbstractCommandLineRunner (Closure Compiler v20180610 API)

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 java.lang.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
`protected static class`	`AbstractCommandLineRunner.CommandLineConfig` Configurations for the command line configs.
`protected static class`	`AbstractCommandLineRunner.FlagEntry<T>` A pair from flag to its value.
`static class`	`AbstractCommandLineRunner.FlagUsageException` An exception thrown when command-line flags are used incorrectly.
`static class`	`AbstractCommandLineRunner.JsModuleSpec` Represents a specification for a js module.
`protected static class`	`AbstractCommandLineRunner.JsonFileSpec` Representation of a source file from an encoded json stream input
`protected static class`	`AbstractCommandLineRunner.JsSourceType` Flag types for js source files.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`addWhitelistWarningsGuard(CompilerOptions options, java.io.File whitelistFile)`
`protected abstract void`	`appendRuntimeTo(java.lang.Appendable out)` Writes whatever runtime libraries are needed to bundle.
`protected void`	`checkModuleName(java.lang.String name)` Validates the module name.
`protected abstract A`	`createCompiler()` Returns the instance of the Compiler to use when `run()` is called.
`protected java.util.List<SourceFile>`	`createExterns(CompilerOptions options)`
`protected java.util.List<SourceFile>`	`createInputs(java.util.List<AbstractCommandLineRunner.FlagEntry<AbstractCommandLineRunner.JsSourceType>> files, boolean allowStdIn, java.util.List<AbstractCommandLineRunner.JsModuleSpec> jsModuleSpecs)` Creates inputs from a list of files.
`protected java.util.List<SourceFile>`	`createInputs(java.util.List<AbstractCommandLineRunner.FlagEntry<AbstractCommandLineRunner.JsSourceType>> files, java.util.List<AbstractCommandLineRunner.JsonFileSpec> jsonFiles, boolean allowStdIn, java.util.List<AbstractCommandLineRunner.JsModuleSpec> jsModuleSpecs)` Creates inputs from a list of source files, zips and json files.
`protected java.util.List<SourceFile>`	`createInputs(java.util.List<AbstractCommandLineRunner.FlagEntry<AbstractCommandLineRunner.JsSourceType>> files, java.util.List<AbstractCommandLineRunner.JsonFileSpec> jsonFiles, java.util.List<AbstractCommandLineRunner.JsModuleSpec> jsModuleSpecs)` Creates inputs from a list of source files 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 java.io.OutputStream`	`filenameToOutputStream(java.lang.String fileName)` Converts a file name into a Outputstream.
`static java.util.List<SourceFile>`	`getBuiltinExterns(CompilerOptions.Environment env)`
`protected 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 java.io.PrintStream`	`getErrorPrintStream()` Returns the PrintStream for writing errors associated with this AbstractCommandLineRunner.
`protected boolean`	`isInTestMode()` Returns whether we're in test mode.
`java.util.List<AbstractCommandLineRunner.JsonFileSpec>`	`parseJsonFilesFromInputStream()`
`protected abstract void`	`prepForBundleAndAppendTo(java.lang.Appendable out, CompilerInput input, java.lang.String content)` Performs any transformation needed on the given compiler input and appends it to the given output bundle.
`static com.google.common.collect.ImmutableList<JSError>`	`removeDuplicateZipEntries(java.util.List<SourceFile> sourceFiles, java.util.List<AbstractCommandLineRunner.JsModuleSpec> jsModuleSpecs)` Check that relative paths inside zip files are unique, since multiple files with the same path inside different zips are considered duplicate inputs.
`void`	`run()` Runs the Compiler and calls System.exit() with the exit status of the compiler.
`void`	`setExitCodeReceiver(com.google.common.base.Function<java.lang.Integer,java.lang.Void> newExitCodeReceiver)`
`protected void`	`setRunOptions(CompilerOptions options)` Sets options based on the configurations set flags API.
`protected static void`	`setWarningGuardOptions(CompilerOptions options, java.util.ArrayList<AbstractCommandLineRunner.FlagEntry<CheckLevel>> warningGuards, DiagnosticGroups diagnosticGroups)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setExitCodeReceiver
```
public void setExitCodeReceiver(com.google.common.base.Function<java.lang.Integer,java.lang.Void> newExitCodeReceiver)
```
Parameters:

newExitCodeReceiver - receives a non-zero integer to indicate a problem during execution or 0i to indicate success.

isInTestMode
```
protected boolean isInTestMode()
```
Returns whether we're in test mode.

getCommandLineConfig

protected 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.

prepForBundleAndAppendTo

protected abstract void prepForBundleAndAppendTo(java.lang.Appendable out,
                                                 CompilerInput input,
                                                 java.lang.String content)
                                          throws java.io.IOException

Performs any transformation needed on the given compiler input and appends it to the given output bundle.

Throws:: java.io.IOException

appendRuntimeTo

protected abstract void appendRuntimeTo(java.lang.Appendable out)
                                 throws java.io.IOException

Writes whatever runtime libraries are needed to bundle.

Throws:: java.io.IOException

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,
                                                  java.io.File whitelistFile)

setWarningGuardOptions

protected static void setWarningGuardOptions(CompilerOptions options,
                                             java.util.ArrayList<AbstractCommandLineRunner.FlagEntry<CheckLevel>> warningGuards,
                                             DiagnosticGroups diagnosticGroups)

setRunOptions
```
protected void setRunOptions(CompilerOptions options)
                      throws java.io.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:

java.io.IOException

getCompiler
```
protected final A getCompiler()
```

getBuiltinExterns

public static java.util.List<SourceFile> getBuiltinExterns(CompilerOptions.Environment env)
                                                    throws java.io.IOException

Returns:: a mutable list
Throws:: java.io.IOException

run
```
public final void run()
```
Runs the Compiler and calls System.exit() with the exit status of the compiler.

getErrorPrintStream
```
protected final java.io.PrintStream getErrorPrintStream()
```
Returns the PrintStream for writing errors associated with this AbstractCommandLineRunner.

parseJsonFilesFromInputStream

public java.util.List<AbstractCommandLineRunner.JsonFileSpec> parseJsonFilesFromInputStream()
                                                                                     throws java.io.IOException

Throws:: java.io.IOException

createInputs
```
protected java.util.List<SourceFile> createInputs(java.util.List<AbstractCommandLineRunner.FlagEntry<AbstractCommandLineRunner.JsSourceType>> files,
                                                  boolean allowStdIn,
                                                  java.util.List<AbstractCommandLineRunner.JsModuleSpec> jsModuleSpecs)
                                           throws java.io.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 flag entries indicates js and zip file names.

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

jsModuleSpecs - A list js module specs.

Returns:

An array of inputs

Throws:

java.io.IOException

createInputs

protected java.util.List<SourceFile> createInputs(java.util.List<AbstractCommandLineRunner.FlagEntry<AbstractCommandLineRunner.JsSourceType>> files,
                                                  java.util.List<AbstractCommandLineRunner.JsonFileSpec> jsonFiles,
                                                  java.util.List<AbstractCommandLineRunner.JsModuleSpec> jsModuleSpecs)
                                           throws java.io.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 flag entries indicates js and zip file names.; jsonFiles - A list of json encoded files.; jsModuleSpecs - A list js module specs.
Returns:: An array of inputs
Throws:: java.io.IOException

createInputs

protected java.util.List<SourceFile> createInputs(java.util.List<AbstractCommandLineRunner.FlagEntry<AbstractCommandLineRunner.JsSourceType>> files,
                                                  java.util.List<AbstractCommandLineRunner.JsonFileSpec> jsonFiles,
                                                  boolean allowStdIn,
                                                  java.util.List<AbstractCommandLineRunner.JsModuleSpec> jsModuleSpecs)
                                           throws java.io.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 flag entries indicates js and zip file names; 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.; jsModuleSpecs - A list js module specs.
Returns:: An array of inputs
Throws:: java.io.IOException

removeDuplicateZipEntries

public static com.google.common.collect.ImmutableList<JSError> removeDuplicateZipEntries(java.util.List<SourceFile> sourceFiles,
                                                                                         java.util.List<AbstractCommandLineRunner.JsModuleSpec> jsModuleSpecs)
                                                                                  throws java.io.IOException

Check that relative paths inside zip files are unique, since multiple files with the same path inside different zips are considered duplicate inputs. Parameter sourceFiles may be modified if duplicates are removed.

Throws:: java.io.IOException

checkModuleName
```
protected void checkModuleName(java.lang.String name)
```
Validates the module name. Can be overridden by subclasses.

Parameters:

name - The module name

doRun
```
protected int doRun()
             throws java.io.IOException
```
Parses command-line arguments and runs the compiler.

Returns:

system exit status

Throws:

java.io.IOException

createExterns

protected java.util.List<SourceFile> createExterns(CompilerOptions options)
                                            throws java.io.IOException

Throws:: java.io.IOException

filenameToOutputStream

protected java.io.OutputStream filenameToOutputStream(java.lang.String fileName)
                                               throws java.io.IOException

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

Throws:: java.io.IOException

Class AbstractCommandLineRunner<A extends Compiler,B extends CompilerOptions>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setExitCodeReceiver

isInTestMode

getCommandLineConfig

createCompiler

prepForBundleAndAppendTo

appendRuntimeTo

createOptions

getDiagnosticGroups

addWhitelistWarningsGuard

setWarningGuardOptions

setRunOptions

getCompiler

getBuiltinExterns

run

getErrorPrintStream

parseJsonFilesFromInputStream

createInputs

createInputs

createInputs

removeDuplicateZipEntries

checkModuleName

doRun

createExterns

filenameToOutputStream