org.jsweet.transpiler.candy

Class CandyProcessor

java.lang.Object

org.jsweet.transpiler.candy.CandyProcessor

public class CandyProcessor
extends Object

The candy processor extracts and processes what is required from the candy jars. It can include:

• embedded TypeScript definition files (*.d.ts)
• embedded JavaScript

Author:

Louis Grignon

Field Summary

Fields

Modifier and Type	Field and Description
static String	CANDIES_DIR_NAME The name of the directory that will contain the candies.
static String	CANDIES_SOURCES_DIR_NAME This directory will contain the sources.
static String	CANDIES_STORE_FILE_NAME The name of the file that stores processed candies info.
static String	CANDIES_TSDEFS_DIR_NAME The name of the directory that contains the TypeScript source files.

Constructor Summary

Constructors

Constructor and Description
CandyProcessor(File workingDir, String classPath, File extractedCandiesJavascriptDir) Create a candies processor.

Method Summary

Modifier and Type	Method and Description
File	getCandiesTsdefsDir() Returns the directory that contains the orginal TypeScript source code of the processed (merged) candies.
List<File>	getExtractedJsFiles()
Map<String,List<File>>	getExtractedJsFilesByCandy()
boolean	hasDeprecatedCandy() Checks if the candy store contains a deprecated candy.
boolean	isUsingJavaRuntime() Returns true if the candy store contains the J4TS candy.
void	processCandies(TranspilationHandler transpilationHandler) Does the processing for the candies jars found in the classpath.
void	touch() Cleans the candies store so that it will be read from file next time.

Methods inherited from class java.lang.Object

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

Field Detail

CANDIES_DIR_NAME

public static final String CANDIES_DIR_NAME

The name of the directory that will contain the candies.

See Also:

Constant Field Values

CANDIES_SOURCES_DIR_NAME

public static final String CANDIES_SOURCES_DIR_NAME

This directory will contain the sources.

CANDIES_STORE_FILE_NAME

public static final String CANDIES_STORE_FILE_NAME

The name of the file that stores processed candies info.

CANDIES_TSDEFS_DIR_NAME

public static final String CANDIES_TSDEFS_DIR_NAME

The name of the directory that contains the TypeScript source files.

Constructor Detail

CandyProcessor

public CandyProcessor(File workingDir,
                      String classPath,
                      File extractedCandiesJavascriptDir)

Create a candies processor.

Parameters:

workingDir - the directory where the processor will save all cache and temporary data for processing

classPath - the classpath where the processor will seek for JSweet candies

extractedCandiesJavascriptDir - see JSweetTranspiler.extractedCandyJavascriptDir

Method Detail

getCandiesTsdefsDir

public File getCandiesTsdefsDir()

Returns the directory that contains the orginal TypeScript source code of the processed (merged) candies.

processCandies

public void processCandies(TranspilationHandler transpilationHandler)
                    throws IOException

Does the processing for the candies jars found in the classpath.

Throws:

IOException

isUsingJavaRuntime

public boolean isUsingJavaRuntime()

Returns true if the candy store contains the J4TS candy.

touch

public void touch()

Cleans the candies store so that it will be read from file next time.

hasDeprecatedCandy

public boolean hasDeprecatedCandy()

Checks if the candy store contains a deprecated candy.

getExtractedJsFiles

public List<File> getExtractedJsFiles()

getExtractedJsFilesByCandy

public Map<String,List<File>> getExtractedJsFilesByCandy()