CompilerInput (Closure Compiler v20171023 API)

java.lang.Object
- com.google.javascript.jscomp.CompilerInput

All Implemented Interfaces:

DependencyInfo, SourceAst, java.io.Serializable
```
public class CompilerInput
extends java.lang.Object
implements SourceAst, DependencyInfo
```
A class for the internal representation of an input to the compiler. Wraps a SourceAst and maintain state such as module for the input and whether the input is an extern. Also calculates provided and required types.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.google.javascript.jscomp.deps.DependencyInfo
  DependencyInfo.Base, DependencyInfo.Util

Constructor Summary

Constructors
Constructor and Description
`CompilerInput(SourceAst ast)`
`CompilerInput(SourceAst ast, boolean isExtern)`
`CompilerInput(SourceAst ast, InputId inputId, boolean isExtern)`
`CompilerInput(SourceAst ast, java.lang.String inputId, boolean isExtern)`
`CompilerInput(SourceFile file)`
`CompilerInput(SourceFile file, boolean isExtern)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addOrderedRequire(java.lang.String require)` Registers a type that this input depends on in the order seen in the file.
`void`	`addProvide(java.lang.String provide)` Registers a type that this input defines.
`void`	`addRequire(java.lang.String require)` Registers a type that this input depends on.
`void`	`clearAst()` Removes any references to root node of the AST.
`Node`	`getAstRoot(AbstractCompiler compiler)` Gets the root node of the AST for the source file this represents.
`java.lang.String`	`getCode()`
`InputId`	`getInputId()` Returns a name for this input.
`com.google.javascript.jscomp.CompilerInput.ModuleType`	`getJsModuleType()`
`int`	`getLineOffset(int lineno)`
`com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String>`	`getLoadFlags()` Gets the loading information for this file.
`JSModule`	`getModule()` Returns the module to which the input belongs.
`java.lang.String`	`getName()` Returns a name for this input.
`int`	`getNumLines()`
`java.lang.String`	`getPathRelativeToClosureBase()` Gets the path relative to closure-base, if one is available.
`java.util.Collection<java.lang.String>`	`getProvides()` Gets a list of types provided by this input.
`java.util.Collection<java.lang.String>`	`getRequires()` Gets a list of types depended on by this input.
`SourceFile`	`getSourceFile()` Returns the source file the generated AST represents.
`boolean`	`isExtern()`
`boolean`	`isModule()` Whether the symbol is provided by a module
`static CompilerInput`	`makePersistentInput(SourceFile file)` Using the RecoverableJsAst, creates a CompilerInput that can be reset() to be safe to reuse in multiple compiler invocations.
`void`	`reset()` Resets the compiler input for reuse in another compile.
`void`	`setCompiler(AbstractCompiler compiler)` Sets an abstract compiler for doing parsing.
`void`	`setHasFullParseDependencyInfo(boolean hasFullParseDependencyInfo)`
`void`	`setJsModuleType(com.google.javascript.jscomp.CompilerInput.ModuleType moduleType)`
`void`	`setModule(JSModule module)` Sets the module to which the input belongs.
`void`	`setSourceFile(SourceFile file)` Sets the source file the generated AST represents.
`java.lang.String`	`toString()`

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

- Constructor Detail
  - CompilerInput
```
public CompilerInput(SourceAst ast)
```
  - CompilerInput
```
public CompilerInput(SourceAst ast,
                     boolean isExtern)
```
  - CompilerInput
```
public CompilerInput(SourceAst ast,
                     java.lang.String inputId,
                     boolean isExtern)
```
  - CompilerInput
```
public CompilerInput(SourceAst ast,
                     InputId inputId,
                     boolean isExtern)
```
  - CompilerInput
```
public CompilerInput(SourceFile file)
```
  - CompilerInput
```
public CompilerInput(SourceFile file,
                     boolean isExtern)
```
- Method Detail
  - makePersistentInput
```
public static CompilerInput makePersistentInput(SourceFile file)
```
    Using the RecoverableJsAst, creates a CompilerInput that can be reset() to be safe to reuse in multiple compiler invocations.
  - getInputId
```
public InputId getInputId()
```
    Returns a name for this input. Must be unique across all inputs.
    
    Specified by:
    
    getInputId in interface SourceAst
    
    Returns:
    
    The input id associated with this AST
  - getName
```
public java.lang.String getName()
```
    Returns a name for this input. Must be unique across all inputs.
    
    Specified by:
    
    getName in interface DependencyInfo
  - getPathRelativeToClosureBase
```
public java.lang.String getPathRelativeToClosureBase()
```
    Gets the path relative to closure-base, if one is available.
    
    Specified by:
    
    getPathRelativeToClosureBase in interface DependencyInfo
  - getAstRoot
```
public Node getAstRoot(AbstractCompiler compiler)
```
    Description copied from interface: SourceAst
    
    Gets the root node of the AST for the source file this represents. The AST is lazily instantiated and cached.
    
    Specified by:
    
    getAstRoot in interface SourceAst
  - clearAst
```
public void clearAst()
```
    Description copied from interface: SourceAst
    
    Removes any references to root node of the AST. If it is requested again, another parse will be performed. This method is needed to allow the ASTs to be garbage collected if the inputs are still around after compilation.
    
    Specified by:
    
    clearAst in interface SourceAst
  - getSourceFile
```
public SourceFile getSourceFile()
```
    Description copied from interface: SourceAst
    
    Returns the source file the generated AST represents.
    
    Specified by:
    
    getSourceFile in interface SourceAst
  - setSourceFile
```
public void setSourceFile(SourceFile file)
```
    Description copied from interface: SourceAst
    
    Sets the source file the generated AST represents. This can be called after deserializing if access to the source file is needed. If a different file is provided than that with which this was created, an IllegalStateException will be thrown.
    
    Specified by:
    
    setSourceFile in interface SourceAst
  - setCompiler
```
public void setCompiler(AbstractCompiler compiler)
```
    Sets an abstract compiler for doing parsing.
  - getRequires
```
public java.util.Collection<java.lang.String> getRequires()
```
    Gets a list of types depended on by this input.
    
    Specified by:
    
    getRequires in interface DependencyInfo
  - getProvides
```
public java.util.Collection<java.lang.String> getProvides()
```
    Gets a list of types provided by this input.
    
    Specified by:
    
    getProvides in interface DependencyInfo
  - addProvide
```
public void addProvide(java.lang.String provide)
```
    Registers a type that this input defines. Includes both explicitly declared namespaces via goog.provide and goog.module calls as well as implicit namespaces provided by module rewriting.
  - addOrderedRequire
```
public boolean addOrderedRequire(java.lang.String require)
```
    Registers a type that this input depends on in the order seen in the file.
  - setHasFullParseDependencyInfo
```
public void setHasFullParseDependencyInfo(boolean hasFullParseDependencyInfo)
```
  - getJsModuleType
```
public com.google.javascript.jscomp.CompilerInput.ModuleType getJsModuleType()
```
  - setJsModuleType
```
public void setJsModuleType(com.google.javascript.jscomp.CompilerInput.ModuleType moduleType)
```
  - addRequire
```
public void addRequire(java.lang.String require)
```
    Registers a type that this input depends on.
  - getCode
```
public java.lang.String getCode()
                         throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - getModule
```
public JSModule getModule()
```
    Returns the module to which the input belongs.
  - setModule
```
public void setModule(JSModule module)
```
    Sets the module to which the input belongs.
  - isExtern
```
public boolean isExtern()
```
  - getLineOffset
```
public int getLineOffset(int lineno)
```
  - getNumLines
```
public int getNumLines()
```
    Returns:
    
    The number of lines in this input.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getLoadFlags
```
public com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> getLoadFlags()
```
    Description copied from interface: DependencyInfo
    
    Gets the loading information for this file.
    
    Specified by:
    
    getLoadFlags in interface DependencyInfo
  - isModule
```
public boolean isModule()
```
    Description copied from interface: DependencyInfo
    
    Whether the symbol is provided by a module
    
    Specified by:
    
    isModule in interface DependencyInfo
  - reset
```
public void reset()
```
    Resets the compiler input for reuse in another compile.

Class CompilerInput

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.javascript.jscomp.deps.DependencyInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CompilerInput

CompilerInput

CompilerInput

CompilerInput

CompilerInput

CompilerInput

Method Detail

makePersistentInput

getInputId

getName

getPathRelativeToClosureBase

getAstRoot

clearAst

getSourceFile

setSourceFile

setCompiler

getRequires

getProvides

addProvide

addOrderedRequire

setHasFullParseDependencyInfo

getJsModuleType

setJsModuleType

addRequire

getCode

getModule

setModule

isExtern

getLineOffset

getNumLines

toString

getLoadFlags

isModule

reset