JSweetOptions (JSweet transpiler 2.2.0-SNAPSHOT API)

All Known Implementing Classes:

JSweetTranspiler
```
public interface JSweetOptions
```
This interface holds all the JSweet transpiler configuration and options.

Author:

Renaud Pawlak

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`bundle` Constant string for the 'bundle' option.
`static String`	`candiesJsOut` Constant string for the 'candiesJsOut' option.
`static String`	`declaration` Constant string for the 'declaration' option.
`static String`	`disableSinglePrecisionFloats` Constant string for the 'disableSinglePrecisionFloats' option.
`static String`	`dtsout` Constant string for the 'dtsout' option.
`static String`	`enableAssertions` Constant string for the 'enableAssertions' option.
`static String`	`encoding` Constant string for the 'encoding' option.
`static String`	`extraSystemPath` Constant string for the 'extraSystemPath' option.
`static String`	`header` Constant string for the 'header' option.
`static String`	`ignoreDefinitions` Constant string for the 'ignoreDefinitions' option.
`static String`	`jsout` Constant string for the 'jsout' option.
`static String`	`module` Constant string for the 'module' option.
`static String`	`moduleResolution` Constant string for the 'moduleResolution' option.
`static String`	`noRootDirectories` Constant string for the 'noRootDirectories' option.
`static String[]`	`options` All the supported options.
`static String`	`sourceMap` Constant string for the 'sourceMap' option.
`static String`	`targetVersion` Constant string for the 'targetVersion' option.
`static String`	`tsOnly` Constant string for the 'tsOnly' option.
`static String`	`tsout` Constant string for the 'tsout' option.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`List<String>`	`getAdapters()` A list of adapter class names (fully qualified) to be used to extend the transpiler behavior.
`Map<String,Object>`	`getConfiguration()` Returns the configuration from the configuration file.
`File`	`getConfigurationFile()` The configuration file, which is by default the `jsweetconfig.json` file in the current project.
`File`	`getDeclarationsOutputDir()` Gets the current .d.ts output directory (only if the declaration option is set).
`EcmaScriptComplianceLevel`	`getEcmaTargetVersion()` The targeted ECMAScript version.
`String`	`getEncoding()` Gets the expected Java source code encoding.
`File`	`getExtractedCandyJavascriptDir()` The directory where the transpiler should put the extracted JavaScript files from candies.
`File`	`getHeaderFile()` Gets the file containing the header to be added to the generated files.
`File`	`getJsOutputDir()` Gets the current JavaScript output directory.
`ModuleKind`	`getModuleKind()` Gets the module kind when transpiling to code using JavaScript modules.
`ModuleResolution`	`getModuleResolution()` Determines how modules get resolved.
`File`	`getSourceRoot()` Gets the source root for the source map files.
`File`	`getTsOutputDir()` Gets the current TypeScript output directory.
`boolean`	`isBundle()` Tells if this transpiler generates JavaScript bundles for running in a Web browser.
`boolean`	`isDebugMode()` If true, the transpiler generates code that can be debugged with JavaScript.
`boolean`	`isDisableSinglePrecisionFloats()` By default, for a target version >=ES5, JSweet will force Java floats to be mapped to JavaScript numbers that will be constrained with the Math.fround function.
`boolean`	`isGenerateDeclarations()` Generates d.ts files along with the js files.
`boolean`	`isGenerateDefinitions()` Generated definitions from def.* packages in d.ts files.
`boolean`	`isGenerateJsFiles()` If false, do not compile TypeScript output (let an external TypeScript compiler do so).
`boolean`	`isGenerateSourceMaps()` Tells if the transpiler generates js.map files for Java debugging.
`boolean`	`isGenerateTsFiles()` If false, do not generate TypeScript output (just validate the Java source code and do not transpile anything).
`boolean`	`isIgnoreAssertions()` Tells if the transpiler should ignore the 'assert' statements or generate appropriate code.
`boolean`	`isIgnoreJavaErrors()` If true, JSweet will ignore any message reported by Java (including error).
`boolean`	`isIgnoreJavaFileNameError()` Generates output code even if the main class is not placed within a file of the same name.
`boolean`	`isIgnoreTypeScriptErrors()` If true, JSweet will ignore any message reported by TypeScript (including error) and the compilation will be successful if no Java error is raised.
`boolean`	`isNoRootDirectories()` Tells if this transpiler skips the root directories (packages annotated with @jsweet.lang.Root) so that the generated file hierarchy starts at the root directories rather than including the entire directory structure.
`boolean`	`isPreserveSourceLineNumbers()` Deprecated. use `isGenerateSourceMaps()` instead
`boolean`	`isSkipTypeScriptChecks()`
`boolean`	`isTscWatchMode()`
`boolean`	`isUsingModules()`
`boolean`	`isVerbose()` If true, JSweet has been launched in verbose mode.

- Field Detail
  - bundle
```
static final String bundle
```
    Constant string for the 'bundle' option.
    
    See Also:
    
    Constant Field Values
  - noRootDirectories
```
static final String noRootDirectories
```
    Constant string for the 'noRootDirectories' option.
    
    See Also:
    
    Constant Field Values
  - sourceMap
```
static final String sourceMap
```
    Constant string for the 'sourceMap' option.
    
    See Also:
    
    Constant Field Values
  - module
```
static final String module
```
    Constant string for the 'module' option.
    
    See Also:
    
    Constant Field Values
  - encoding
```
static final String encoding
```
    Constant string for the 'encoding' option.
    
    See Also:
    
    Constant Field Values
  - enableAssertions
```
static final String enableAssertions
```
    Constant string for the 'enableAssertions' option.
    
    See Also:
    
    Constant Field Values
  - declaration
```
static final String declaration
```
    Constant string for the 'declaration' option.
    
    See Also:
    
    Constant Field Values
  - tsOnly
```
static final String tsOnly
```
    Constant string for the 'tsOnly' option.
    
    See Also:
    
    Constant Field Values
  - ignoreDefinitions
```
static final String ignoreDefinitions
```
    Constant string for the 'ignoreDefinitions' option.
    
    See Also:
    
    Constant Field Values
  - header
```
static final String header
```
    Constant string for the 'header' option.
    
    See Also:
    
    Constant Field Values
  - disableSinglePrecisionFloats
```
static final String disableSinglePrecisionFloats
```
    Constant string for the 'disableSinglePrecisionFloats' option.
    
    See Also:
    
    Constant Field Values
  - targetVersion
```
static final String targetVersion
```
    Constant string for the 'targetVersion' option.
    
    See Also:
    
    Constant Field Values
  - tsout
```
static final String tsout
```
    Constant string for the 'tsout' option.
    
    See Also:
    
    Constant Field Values
  - dtsout
```
static final String dtsout
```
    Constant string for the 'dtsout' option.
    
    See Also:
    
    Constant Field Values
  - jsout
```
static final String jsout
```
    Constant string for the 'jsout' option.
    
    See Also:
    
    Constant Field Values
  - candiesJsOut
```
static final String candiesJsOut
```
    Constant string for the 'candiesJsOut' option.
    
    See Also:
    
    Constant Field Values
  - moduleResolution
```
static final String moduleResolution
```
    Constant string for the 'moduleResolution' option.
    
    See Also:
    
    Constant Field Values
  - extraSystemPath
```
static final String extraSystemPath
```
    Constant string for the 'extraSystemPath' option.
    
    See Also:
    
    Constant Field Values
  - options
```
static final String[] options
```
    All the supported options.
- Method Detail
  - getConfiguration
```
Map<String,Object> getConfiguration()
```
    Returns the configuration from the configuration file.
  - isPreserveSourceLineNumbers
```
@Deprecated
boolean isPreserveSourceLineNumbers()
```
    Deprecated. use isGenerateSourceMaps() instead
    
    Tells if the transpiler generates js.map files for Java debugging.
  - isGenerateSourceMaps
```
boolean isGenerateSourceMaps()
```
    Tells if the transpiler generates js.map files for Java debugging.
  - getSourceRoot
```
File getSourceRoot()
```
    Gets the source root for the source map files. Use this option if the Java source is located in a different place at runtime.
  - getTsOutputDir
```
File getTsOutputDir()
```
    Gets the current TypeScript output directory.
  - getJsOutputDir
```
File getJsOutputDir()
```
    Gets the current JavaScript output directory.
  - getDeclarationsOutputDir
```
File getDeclarationsOutputDir()
```
    Gets the current .d.ts output directory (only if the declaration option is set).
    By default, declarations are placed in the JavaScript output directory.
  - getModuleKind
```
ModuleKind getModuleKind()
```
    Gets the module kind when transpiling to code using JavaScript modules.
  - isBundle
```
boolean isBundle()
```
    Tells if this transpiler generates JavaScript bundles for running in a Web browser.
  - getEncoding
```
String getEncoding()
```
    Gets the expected Java source code encoding.
  - isNoRootDirectories
```
boolean isNoRootDirectories()
```
    Tells if this transpiler skips the root directories (packages annotated with @jsweet.lang.Root) so that the generated file hierarchy starts at the root directories rather than including the entire directory structure.
  - isIgnoreAssertions
```
boolean isIgnoreAssertions()
```
    Tells if the transpiler should ignore the 'assert' statements or generate appropriate code.
  - isIgnoreJavaFileNameError
```
boolean isIgnoreJavaFileNameError()
```
    Generates output code even if the main class is not placed within a file of the same name.
  - isGenerateDeclarations
```
boolean isGenerateDeclarations()
```
    Generates d.ts files along with the js files.
  - getExtractedCandyJavascriptDir
```
File getExtractedCandyJavascriptDir()
```
    The directory where the transpiler should put the extracted JavaScript files from candies. Candies can bundle one or more JavaScript files that will be extracted to this directory.
  - isGenerateJsFiles
```
boolean isGenerateJsFiles()
```
    If false, do not compile TypeScript output (let an external TypeScript compiler do so). Default is true.
  - isGenerateTsFiles
```
boolean isGenerateTsFiles()
```
    If false, do not generate TypeScript output (just validate the Java source code and do not transpile anything). Default is true.
  - isGenerateDefinitions
```
boolean isGenerateDefinitions()
```
    Generated definitions from def.* packages in d.ts files.
  - isIgnoreTypeScriptErrors
```
boolean isIgnoreTypeScriptErrors()
```
    If true, JSweet will ignore any message reported by TypeScript (including error) and the compilation will be successful if no Java error is raised.
  - isIgnoreJavaErrors
```
boolean isIgnoreJavaErrors()
```
    If true, JSweet will ignore any message reported by Java (including error).
  - getHeaderFile
```
File getHeaderFile()
```
    Gets the file containing the header to be added to the generated files.
    
    Returns:
    
    the header file, null if undefined
  - isDebugMode
```
boolean isDebugMode()
```
    If true, the transpiler generates code that can be debugged with JavaScript.
  - isVerbose
```
boolean isVerbose()
```
    If true, JSweet has been launched in verbose mode.
  - isDisableSinglePrecisionFloats
```
boolean isDisableSinglePrecisionFloats()
```
    By default, for a target version >=ES5, JSweet will force Java floats to be mapped to JavaScript numbers that will be constrained with the Math.fround function. If this option is true, then the calls to Math.fround are erased and the generated program will use the JavaScript default precision (double precision).
  - getEcmaTargetVersion
```
EcmaScriptComplianceLevel getEcmaTargetVersion()
```
    The targeted ECMAScript version.
  - getAdapters
```
List<String> getAdapters()
```
    A list of adapter class names (fully qualified) to be used to extend the transpiler behavior. As the name suggests, an adapter is an instance of PrinterAdapter that adapts the TypeScript default printer in order to tune the generated code. All the adapter classes must be accessible within the 'jsweet_extension' directory to be created at the root of the transpiled project. The adapter classes can be provided as Java class files (*.class) or Java source files (*.java). In the latter case, they will be on-the-fly compiled by JSweet.
    
    See Also:
    
    PrinterAdapter
  - getModuleResolution
```
ModuleResolution getModuleResolution()
```
    Determines how modules get resolved. Either "Node" for Node.js/io.js style resolution, or "Classic". See Tsc's Module Resolution documentation for more details.
    
    Returns:
    
    the current module resolution strategy
  - getConfigurationFile
```
File getConfigurationFile()
```
    The configuration file, which is by default the jsweetconfig.json file in the current project.
  - isUsingModules
```
boolean isUsingModules()
```
    Returns:
    
    true if module is set to somethind else than ModuleKind.none
  - isSkipTypeScriptChecks
```
boolean isSkipTypeScriptChecks()
```
  - isTscWatchMode
```
boolean isTscWatchMode()
```
    Returns:
    
    true to enable tsc watch mode

Interface JSweetOptions

Field Summary

Method Summary

Field Detail

bundle

noRootDirectories

sourceMap

module

encoding

enableAssertions

declaration

tsOnly

ignoreDefinitions

header

disableSinglePrecisionFloats

targetVersion

tsout

dtsout

jsout

candiesJsOut

moduleResolution

extraSystemPath

options

Method Detail

getConfiguration

isPreserveSourceLineNumbers

isGenerateSourceMaps

getSourceRoot

getTsOutputDir

getJsOutputDir

getDeclarationsOutputDir

getModuleKind

isBundle

getEncoding

isNoRootDirectories

isIgnoreAssertions

isIgnoreJavaFileNameError

isGenerateDeclarations

getExtractedCandyJavascriptDir

isGenerateJsFiles

isGenerateTsFiles

isGenerateDefinitions

isIgnoreTypeScriptErrors

isIgnoreJavaErrors

getHeaderFile

isDebugMode

isVerbose

isDisableSinglePrecisionFloats

getEcmaTargetVersion

getAdapters

getModuleResolution

getConfigurationFile

isUsingModules

isSkipTypeScriptChecks

isTscWatchMode