org.jsweet.transpiler

Class JSweetFactory

java.lang.Object

org.jsweet.transpiler.JSweetFactory

Direct Known Subclasses:

RemoveJavaDependenciesFactory

public class JSweetFactory
extends Object

The factory object is the one creating instances for key JSweet transpilation elements. By subclassing the factory, programmers can extend the transpiler behavior.

Author:

Renaud Pawlak

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	logger A logger to be used for internal messages.

Constructor Summary

Constructors

Constructor and Description
JSweetFactory() An empty constructor is mandatory for all subclasses.

Method Summary

Modifier and Type	Method and Description
PrinterAdapter	createAdapter(JSweetContext context) Creates the printer adapter or any subclass.
GlobalBeforeTranslationScanner	createBeforeTranslationScanner(TranspilationHandler transpilationHandler, JSweetContext context) Creates the scanner which is called before translating the program.
JSweetContext	createContext(JSweetOptions options) Creates the transpiler's context or any subclass.
JSweetDiagnosticHandler	createDiagnosticHandler(TranspilationHandler transpilationHandler, JSweetContext context) Creates a diagnostic handler (responsible for reporting Java errors/warnings).
Java2TypeScriptTranslator	createTranslator(PrinterAdapter adapter, TranspilationHandler transpilationHandler, JSweetContext context, com.sun.tools.javac.tree.JCTree.JCCompilationUnit compilationUnit, boolean fillSourceMap) Creates the core translator or any subclass.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.apache.log4j.Logger logger

A logger to be used for internal messages.

Constructor Detail

JSweetFactory

public JSweetFactory()

An empty constructor is mandatory for all subclasses.

Method Detail

createContext

public JSweetContext createContext(JSweetOptions options)

Creates the transpiler's context or any subclass.

createAdapter

public PrinterAdapter createAdapter(JSweetContext context)

Creates the printer adapter or any subclass.

This is the method to be overridden to create composable extensions. Adapters are chainable (decorator pattern) and new adapters will delegate to parent adapters when not overriding the parent behavior.

For instance, here my own adapter will override the needed behavior and delegate to the default adapter chain:

 @Override
 public PrinterAdapter createAdapter(JSweetContext context) {
        return new MyOwnAdapter(super.createAdapter(context));
 }
 

createTranslator

public Java2TypeScriptTranslator createTranslator(PrinterAdapter adapter,
                                                  TranspilationHandler transpilationHandler,
                                                  JSweetContext context,
                                                  com.sun.tools.javac.tree.JCTree.JCCompilationUnit compilationUnit,
                                                  boolean fillSourceMap)

Creates the core translator or any subclass.

createBeforeTranslationScanner

public GlobalBeforeTranslationScanner createBeforeTranslationScanner(TranspilationHandler transpilationHandler,
                                                                     JSweetContext context)

Creates the scanner which is called before translating the program.

A typical use would be to return a subclass of GlobalBeforeTranslationScanner in order to fill the context with some specific global analysis results that can be used later on by the translator.

createDiagnosticHandler

public JSweetDiagnosticHandler createDiagnosticHandler(TranspilationHandler transpilationHandler,
                                                       JSweetContext context)

Creates a diagnostic handler (responsible for reporting Java errors/warnings).

One can override with a subclass to tune how JSweet reports Java messages.