JSweetConfig (JSweet transpiler 2.2.0-SNAPSHOT API)

java.lang.Object
- org.jsweet.JSweetConfig

```
public abstract class JSweetConfig
extends Object
```
This class contains static constants and utilities.

Author:

Renaud Pawlak

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ANNOTATION_AMBIENT` Fully-qualified name for the JSweet `@Ambient` annotation (see JSweet core API).
`static String`	`ANNOTATION_ASYNC` Fully-qualified name for the JSweet `@Async` annotation (see JSweet core API).
`static String`	`ANNOTATION_DECORATOR` Fully-qualified name for the JSweet `@Decorator` annotation (see JSweet core API).
`static String`	`ANNOTATION_DISABLED` Fully-qualified name for the JSweet `@Disabled` annotation (see JSweet core API).
`static String`	`ANNOTATION_ERASED` Fully-qualified name for the JSweet `@Erased` annotation (see JSweet core API).
`static String`	`ANNOTATION_FUNCTIONAL_INTERFACE` Fully-qualified name for the built-in Java `FunctionalInterface` annotation.
`static String`	`ANNOTATION_GENERATOR` Fully-qualified name for the JSweet `@Generator` annotation (see JSweet core API).
`static String`	`ANNOTATION_INTERFACE` Fully-qualified name for the JSweet `@Interface` annotation (see JSweet core API).
`static String`	`ANNOTATION_MIXIN` Fully-qualified name for the JSweet `@Mixin` annotation (see JSweet core API).
`static String`	`ANNOTATION_MODULE` Fully-qualified name for the JSweet `@Module` annotation (see JSweet core API).
`static String`	`ANNOTATION_NAME` Fully-qualified name for the JSweet `@Name` annotation (see JSweet core API).
`static String`	`ANNOTATION_NO_DEBUG` Fully-qualified name for the JSweet `@SNoDebug` annotation (see JSweet core API).
`static String`	`ANNOTATION_OBJECT_TYPE` Fully-qualified name for the JSweet `@ObjectType` annotation (see JSweet core API).
`static String`	`ANNOTATION_OPTIONAL` Fully-qualified name for the JSweet `@Optional` annotation (see JSweet core API).
`static String`	`ANNOTATION_REPLACE` Fully-qualified name for the JSweet `@Replace` annotation (see JSweet core API).
`static String`	`ANNOTATION_ROOT` Fully-qualified name for the JSweet `@Root` annotation (see JSweet core API).
`static String`	`ANNOTATION_STRING_TYPE` Fully-qualified name for the JSweet `@StringType` annotation (see JSweet core API).
`static String`	`ANNOTATION_SYNTACTIC_ITERABLE` Fully-qualified name for the JSweet `@SyntacticIterable` annotation (see JSweet core API).
`static String`	`ANNOTATION_WRAP_PARAMETERS` Fully-qualified name for the JSweet `@WrapParameters` annotation (see JSweet core API).
`static String`	`ANONYMOUS_DEPRECATED_FUNCTION_NAME`
`static String`	`ANONYMOUS_DEPRECATED_STATIC_FUNCTION_NAME`
`static String`	`ANONYMOUS_FUNCTION_NAME`
`static String`	`ANONYMOUS_STATIC_FUNCTION_NAME`
`static Properties`	`APPLICATION_PROPERTIES` The properties coming from application.properties.
`static String`	`CONFIGURATION_FILE_NAME` The default configuration file name.
`static String`	`DEPRECATED_UTIL_CLASSNAME` The constant for predefined utilities.
`static String`	`DOM_PACKAGE` The constant for the JSweet dom package.
`static String`	`EXTENSION_DIR`
`static String`	`FIELD_METHOD_CLASH_RESOLVER_PREFIX` The prefix to add to variables that clash with methods.
`static String`	`FUNCTION_CLASSES_PACKAGE` The constant for the function classes package.
`static String`	`GLOBALS_CLASS_NAME` The constant for the classes where members are generated as top-level elements (global variables and functions).
`static String`	`GLOBALS_PACKAGE_NAME` The constant for the package generates top-level classes (one cannot use unnamed package in Java).
`static String`	`INDEXED_DELETE_FUCTION_NAME`
`static String`	`INDEXED_DELETE_STATIC_FUCTION_NAME`
`static String`	`INDEXED_GET_FUCTION_NAME` The constant for indexed access function.
`static String`	`INDEXED_GET_STATIC_FUCTION_NAME`
`static String`	`INDEXED_SET_FUCTION_NAME` The constant for indexed assignment function.
`static String`	`INDEXED_SET_STATIC_FUCTION_NAME` The constant for indexed assignment function.
`static Set<String>`	`JAVA_KEYWORDS` This map contains the Java keywords that are taken into account in the generation for avoiding keyword clashes.
`static String`	`JS_KEYWORD_PREFIX` The prefix to add to variables that clash with JS keywords.
`static Set<String>`	`JS_KEYWORDS` This map contains the JS keywords that are taken into account in the generation for avoiding keyword clashes.
`static String`	`LANG_PACKAGE` The constant for the JSweet lang package.
`static String`	`LANG_PACKAGE_ALT` The constant for the JSweet lang package.
`static String`	`LIBS_PACKAGE` The constant for the JSweet lib package (where the definitions need to be).
`static String`	`MAIN_FUNCTION_NAME` The constant for main functions (translate to global code, which is executed when the file is loaded).
`static String`	`MAVEN_CANDIES_GROUP` The Maven group id where candies are deployed.
`static String`	`MAVEN_JAVA_OVERRIDE_ARTIFACT` The Maven artifact full name for the Java override project.
`static String`	`MODULE_FILE_NAME` The TypeScript module file names, when transpiling with modules (without extension).
`static String`	`NEW_FUNCTION_NAME`
`static String`	`OBJECT_CLASSNAME` The fully qualified name of a JavaScript Object in JSweet.
`static String`	`STRING_TYPES_INTERFACE_NAME` The constant for the interface name that contains all the generated string types (short name).
`static Set<Character>`	`TS_IDENTIFIER_FORBIDDEN_CHARS` This collection contains the forbidden characters in TS identifiers
`static String`	`TS_LIBS_DIR_NAME` Default name of the directory where the TypeScript definition files can be found.
`static Set<String>`	`TS_STRICT_MODE_KEYWORDS` This map contains the TS keywords that are taken into account in strict mode (within classes).
`static Set<String>`	`TS_TOP_LEVEL_KEYWORDS` This map contains the TS keywords that are taken into account at top level.
`static String`	`TUPLE_CLASSES_PACKAGE` The constant for the tuple classes package.
`static String`	`TUPLE_CLASSES_PREFIX` The constant for the tuple classes prefix.
`static String`	`UNION_CLASS_NAME` The constant for the Union core class full name.
`static String`	`UNION_PACKAGE` The constant for the package containing union types.
`static String`	`UTIL_CLASSNAME`
`static String`	`UTIL_PACKAGE` The constant for the JSweet util package.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getBuildDate()` The build date coming from Maven.
`static String`	`getVersionNumber()` The version coming from Maven.
`static void`	`initClassPath(String jdkHome)` Initialize the classpath to include tools.jar.
`static boolean`	`isJDKPath(String qualifiedName)` Tells if this qualified name belongs to the JDK (starts with or ).
`static boolean`	`isJDKReplacementMode()`
`static boolean`	`isJSweetPath(String qualifiedName)` Tells if this qualified name belongs to one of the JSweet core package.
`static boolean`	`isLibPath(String qualifiedName)` Tells if this qualified name belongs to any TypeScript library definition (starts with "def").

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

- Field Detail
  - APPLICATION_PROPERTIES
```
public static Properties APPLICATION_PROPERTIES
```
    The properties coming from application.properties.
  - MAVEN_CANDIES_GROUP
```
public static String MAVEN_CANDIES_GROUP
```
    The Maven group id where candies are deployed.
  - MAVEN_JAVA_OVERRIDE_ARTIFACT
```
public static String MAVEN_JAVA_OVERRIDE_ARTIFACT
```
    The Maven artifact full name for the Java override project.
  - LIBS_PACKAGE
```
public static final String LIBS_PACKAGE
```
    The constant for the JSweet lib package (where the definitions need to be).
    
    See Also:
    
    Constant Field Values
  - LANG_PACKAGE
```
public static final String LANG_PACKAGE
```
    The constant for the JSweet lang package.
    
    See Also:
    
    Constant Field Values
  - LANG_PACKAGE_ALT
```
public static final String LANG_PACKAGE_ALT
```
    The constant for the JSweet lang package.
    
    See Also:
    
    Constant Field Values
  - UTIL_PACKAGE
```
public static final String UTIL_PACKAGE
```
    The constant for the JSweet util package.
    
    See Also:
    
    Constant Field Values
  - DOM_PACKAGE
```
public static final String DOM_PACKAGE
```
    The constant for the JSweet dom package.
    
    See Also:
    
    Constant Field Values
  - GLOBALS_PACKAGE_NAME
```
public static final String GLOBALS_PACKAGE_NAME
```
    The constant for the package generates top-level classes (one cannot use unnamed package in Java).
    
    See Also:
    
    Constant Field Values
  - GLOBALS_CLASS_NAME
```
public static final String GLOBALS_CLASS_NAME
```
    The constant for the classes where members are generated as top-level elements (global variables and functions).
    
    See Also:
    
    Constant Field Values
  - DEPRECATED_UTIL_CLASSNAME
```
public static final String DEPRECATED_UTIL_CLASSNAME
```
    The constant for predefined utilities.
    
    See Also:
    
    Constant Field Values
  - UTIL_CLASSNAME
```
public static final String UTIL_CLASSNAME
```
    See Also:
    
    Constant Field Values
  - STRING_TYPES_INTERFACE_NAME
```
public static final String STRING_TYPES_INTERFACE_NAME
```
    The constant for the interface name that contains all the generated string types (short name).
    
    See Also:
    
    Constant Field Values
  - FUNCTION_CLASSES_PACKAGE
```
public static final String FUNCTION_CLASSES_PACKAGE
```
    The constant for the function classes package.
    
    See Also:
    
    Constant Field Values
  - TUPLE_CLASSES_PACKAGE
```
public static final String TUPLE_CLASSES_PACKAGE
```
    The constant for the tuple classes package.
    
    See Also:
    
    Constant Field Values
  - TUPLE_CLASSES_PREFIX
```
public static final String TUPLE_CLASSES_PREFIX
```
    The constant for the tuple classes prefix.
    
    See Also:
    
    Constant Field Values
  - UNION_PACKAGE
```
public static final String UNION_PACKAGE
```
    The constant for the package containing union types.
    
    See Also:
    
    Constant Field Values
  - UNION_CLASS_NAME
```
public static final String UNION_CLASS_NAME
```
    The constant for the Union core class full name.
    
    See Also:
    
    Constant Field Values
  - INDEXED_GET_FUCTION_NAME
```
public static final String INDEXED_GET_FUCTION_NAME
```
    The constant for indexed access function.
    
    See Also:
    
    Constant Field Values
  - INDEXED_SET_FUCTION_NAME
```
public static final String INDEXED_SET_FUCTION_NAME
```
    The constant for indexed assignment function.
    
    See Also:
    
    Constant Field Values
  - INDEXED_DELETE_FUCTION_NAME
```
public static final String INDEXED_DELETE_FUCTION_NAME
```
    See Also:
    
    Constant Field Values
  - INDEXED_GET_STATIC_FUCTION_NAME
```
public static final String INDEXED_GET_STATIC_FUCTION_NAME
```
    See Also:
    
    Constant Field Values
  - INDEXED_SET_STATIC_FUCTION_NAME
```
public static final String INDEXED_SET_STATIC_FUCTION_NAME
```
    The constant for indexed assignment function.
    
    See Also:
    
    Constant Field Values
  - INDEXED_DELETE_STATIC_FUCTION_NAME
```
public static final String INDEXED_DELETE_STATIC_FUCTION_NAME
```
    See Also:
    
    Constant Field Values
  - NEW_FUNCTION_NAME
```
public static final String NEW_FUNCTION_NAME
```
    See Also:
    
    Constant Field Values
  - ANONYMOUS_DEPRECATED_FUNCTION_NAME
```
public static final String ANONYMOUS_DEPRECATED_FUNCTION_NAME
```
    See Also:
    
    Constant Field Values
  - ANONYMOUS_FUNCTION_NAME
```
public static final String ANONYMOUS_FUNCTION_NAME
```
    See Also:
    
    Constant Field Values
  - ANONYMOUS_DEPRECATED_STATIC_FUNCTION_NAME
```
public static final String ANONYMOUS_DEPRECATED_STATIC_FUNCTION_NAME
```
    See Also:
    
    Constant Field Values
  - ANONYMOUS_STATIC_FUNCTION_NAME
```
public static final String ANONYMOUS_STATIC_FUNCTION_NAME
```
    See Also:
    
    Constant Field Values
  - EXTENSION_DIR
```
public static final String EXTENSION_DIR
```
    See Also:
    
    Constant Field Values
  - TS_LIBS_DIR_NAME
```
public static final String TS_LIBS_DIR_NAME
```
    Default name of the directory where the TypeScript definition files can be found.
    
    See Also:
    
    Constant Field Values
  - MAIN_FUNCTION_NAME
```
public static final String MAIN_FUNCTION_NAME
```
    The constant for main functions (translate to global code, which is executed when the file is loaded).
    
    See Also:
    
    Constant Field Values
  - MODULE_FILE_NAME
```
public static final String MODULE_FILE_NAME
```
    The TypeScript module file names, when transpiling with modules (without extension).
    
    See Also:
    
    Constant Field Values
  - OBJECT_CLASSNAME
```
public static final String OBJECT_CLASSNAME
```
    The fully qualified name of a JavaScript Object in JSweet.
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_DISABLED
```
public static final String ANNOTATION_DISABLED
```
    Fully-qualified name for the JSweet @Disabled annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_ERASED
```
public static final String ANNOTATION_ERASED
```
    Fully-qualified name for the JSweet @Erased annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_ASYNC
```
public static final String ANNOTATION_ASYNC
```
    Fully-qualified name for the JSweet @Async annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_SYNTACTIC_ITERABLE
```
public static final String ANNOTATION_SYNTACTIC_ITERABLE
```
    Fully-qualified name for the JSweet @SyntacticIterable annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_AMBIENT
```
public static final String ANNOTATION_AMBIENT
```
    Fully-qualified name for the JSweet @Ambient annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_MIXIN
```
public static final String ANNOTATION_MIXIN
```
    Fully-qualified name for the JSweet @Mixin annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_OBJECT_TYPE
```
public static final String ANNOTATION_OBJECT_TYPE
```
    Fully-qualified name for the JSweet @ObjectType annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_MODULE
```
public static final String ANNOTATION_MODULE
```
    Fully-qualified name for the JSweet @Module annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_INTERFACE
```
public static final String ANNOTATION_INTERFACE
```
    Fully-qualified name for the JSweet @Interface annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_OPTIONAL
```
public static final String ANNOTATION_OPTIONAL
```
    Fully-qualified name for the JSweet @Optional annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_STRING_TYPE
```
public static final String ANNOTATION_STRING_TYPE
```
    Fully-qualified name for the JSweet @StringType annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_ROOT
```
public static final String ANNOTATION_ROOT
```
    Fully-qualified name for the JSweet @Root annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_NAME
```
public static final String ANNOTATION_NAME
```
    Fully-qualified name for the JSweet @Name annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_DECORATOR
```
public static final String ANNOTATION_DECORATOR
```
    Fully-qualified name for the JSweet @Decorator annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_REPLACE
```
public static final String ANNOTATION_REPLACE
```
    Fully-qualified name for the JSweet @Replace annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_GENERATOR
```
public static final String ANNOTATION_GENERATOR
```
    Fully-qualified name for the JSweet @Generator annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_NO_DEBUG
```
public static final String ANNOTATION_NO_DEBUG
```
    Fully-qualified name for the JSweet @SNoDebug annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_WRAP_PARAMETERS
```
public static final String ANNOTATION_WRAP_PARAMETERS
```
    Fully-qualified name for the JSweet @WrapParameters annotation (see JSweet core API).
    
    See Also:
    
    Constant Field Values
  - ANNOTATION_FUNCTIONAL_INTERFACE
```
public static final String ANNOTATION_FUNCTIONAL_INTERFACE
```
    Fully-qualified name for the built-in Java FunctionalInterface annotation.
  - JAVA_KEYWORDS
```
public static final Set<String> JAVA_KEYWORDS
```
    This map contains the Java keywords that are taken into account in the generation for avoiding keyword clashes.
  - JS_KEYWORDS
```
public static final Set<String> JS_KEYWORDS
```
    This map contains the JS keywords that are taken into account in the generation for avoiding keyword clashes.
  - TS_STRICT_MODE_KEYWORDS
```
public static final Set<String> TS_STRICT_MODE_KEYWORDS
```
    This map contains the TS keywords that are taken into account in strict mode (within classes).
  - TS_TOP_LEVEL_KEYWORDS
```
public static final Set<String> TS_TOP_LEVEL_KEYWORDS
```
    This map contains the TS keywords that are taken into account at top level.
  - TS_IDENTIFIER_FORBIDDEN_CHARS
```
public static final Set<Character> TS_IDENTIFIER_FORBIDDEN_CHARS
```
    This collection contains the forbidden characters in TS identifiers
  - JS_KEYWORD_PREFIX
```
public static final String JS_KEYWORD_PREFIX
```
    The prefix to add to variables that clash with JS keywords.
    
    See Also:
    
    Constant Field Values
  - FIELD_METHOD_CLASH_RESOLVER_PREFIX
```
public static final String FIELD_METHOD_CLASH_RESOLVER_PREFIX
```
    The prefix to add to variables that clash with methods.
    
    See Also:
    
    Constant Field Values
  - CONFIGURATION_FILE_NAME
```
public static final String CONFIGURATION_FILE_NAME
```
    The default configuration file name.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getVersionNumber
```
public static String getVersionNumber()
```
    The version coming from Maven.
  - getBuildDate
```
public static String getBuildDate()
```
    The build date coming from Maven.
  - initClassPath
```
public static void initClassPath(String jdkHome)
```
    Initialize the classpath to include tools.jar.
    
    Parameters:
    
    jdkHome - the jdkHome option value (if not set or not found, fall back to the JAVA_HOME environment variable)
    
    handler - the transpilation handler that should report an error if tools.jar is not found (if null uses the default logger)
  - isJDKReplacementMode
```
public static boolean isJDKReplacementMode()
```
  - isJDKPath
```
public static boolean isJDKPath(String qualifiedName)
```
    Tells if this qualified name belongs to the JDK (starts with or ).
  - isLibPath
```
public static boolean isLibPath(String qualifiedName)
```
    Tells if this qualified name belongs to any TypeScript library definition (starts with "def").
  - isJSweetPath
```
public static boolean isJSweetPath(String qualifiedName)
```
    Tells if this qualified name belongs to one of the JSweet core package.

Class JSweetConfig

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

APPLICATION_PROPERTIES

MAVEN_CANDIES_GROUP

MAVEN_JAVA_OVERRIDE_ARTIFACT

LIBS_PACKAGE

LANG_PACKAGE

LANG_PACKAGE_ALT

UTIL_PACKAGE

DOM_PACKAGE

GLOBALS_PACKAGE_NAME

GLOBALS_CLASS_NAME

DEPRECATED_UTIL_CLASSNAME

UTIL_CLASSNAME

STRING_TYPES_INTERFACE_NAME

FUNCTION_CLASSES_PACKAGE

TUPLE_CLASSES_PACKAGE

TUPLE_CLASSES_PREFIX

UNION_PACKAGE

UNION_CLASS_NAME

INDEXED_GET_FUCTION_NAME

INDEXED_SET_FUCTION_NAME

INDEXED_DELETE_FUCTION_NAME

INDEXED_GET_STATIC_FUCTION_NAME

INDEXED_SET_STATIC_FUCTION_NAME

INDEXED_DELETE_STATIC_FUCTION_NAME

NEW_FUNCTION_NAME

ANONYMOUS_DEPRECATED_FUNCTION_NAME

ANONYMOUS_FUNCTION_NAME

ANONYMOUS_DEPRECATED_STATIC_FUNCTION_NAME

ANONYMOUS_STATIC_FUNCTION_NAME

EXTENSION_DIR

TS_LIBS_DIR_NAME

MAIN_FUNCTION_NAME

MODULE_FILE_NAME

OBJECT_CLASSNAME

ANNOTATION_DISABLED

ANNOTATION_ERASED

ANNOTATION_ASYNC

ANNOTATION_SYNTACTIC_ITERABLE

ANNOTATION_AMBIENT

ANNOTATION_MIXIN

ANNOTATION_OBJECT_TYPE

ANNOTATION_MODULE

ANNOTATION_INTERFACE

ANNOTATION_OPTIONAL

ANNOTATION_STRING_TYPE

ANNOTATION_ROOT

ANNOTATION_NAME

ANNOTATION_DECORATOR

ANNOTATION_REPLACE

ANNOTATION_GENERATOR

ANNOTATION_NO_DEBUG

ANNOTATION_WRAP_PARAMETERS

ANNOTATION_FUNCTIONAL_INTERFACE

JAVA_KEYWORDS

JS_KEYWORDS

TS_STRICT_MODE_KEYWORDS

TS_TOP_LEVEL_KEYWORDS

TS_IDENTIFIER_FORBIDDEN_CHARS

JS_KEYWORD_PREFIX

FIELD_METHOD_CLASH_RESOLVER_PREFIX

CONFIGURATION_FILE_NAME

Method Detail

getVersionNumber

getBuildDate

initClassPath

isJDKReplacementMode

isJDKPath

isLibPath

isJSweetPath