TeaVM (TeaVM core 0.3.0 API)

java.lang.Object
- org.teavm.vm.TeaVM

All Implemented Interfaces:: ServiceRepository, TeaVMHost

public class TeaVM
extends Object
implements TeaVMHost, ServiceRepository

TeaVM itself. This class builds a JavaScript VM that runs a certain code. Here you can specify entry points into your code (such like main method). TeaVM guarantees that all required classes and methods will be provided by built VM.

Here is a typical code snippet:


ClassLoader classLoader = ...; // obtain ClassLoader somewhere
ClassHolderSource classSource = new ClasspathClassHolderSource(classLoader);
TeaVM vm = new TeaVMBuilder()
        .setClassLoader(classLoader)
        .setClassSource(classSource)
        .build();
vm.setMinifying(false); // optionally disable obfuscation
vm.installPlugins();    // install all default plugins
                        // that are found in a classpath
vm.entryPoint("main", new MethodReference(
        "fully.qualified.ClassName",  "main",
         ValueType.array(ValueType.object("java.lang.String")),
         ValueType.VOID));
StringBuilder sb = new StringBuilder();
vm.build(sb, null);
vm.checkForMissingItems();

Author:: Alexey Andreev

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(ClassHolderTransformer transformer)`
`void`	`add(DependencyListener listener)`
`void`	`add(MethodReference methodRef, Generator generator)`
`void`	`add(MethodReference methodRef, Injector injector)`
`void`	`add(RendererListener listener)`
`void`	`build(Appendable writer, BuildTarget target)` Does actual build.
`void`	`build(File dir, String fileName)`
`TeaVMEntryPoint`	`entryPoint(MethodReference ref)` Adds an entry point.
`TeaVMEntryPoint`	`entryPoint(String name, MethodReference ref)` Adds an entry point.
`void`	`exportType(String name, String className)`
`MethodNodeCache`	`getAstCache()`
`Collection<String>`	`getClasses()`
`ClassLoader`	`getClassLoader()` Gets class loaded that is used by TeaVM.
`ClassReaderSource`	`getClassSource()` Gets a `ClassReaderSource` which is used by this TeaVM instance.
`DebugInformationEmitter`	`getDebugEmitter()`
`ClassReaderSource`	`getDependencyClassSource()` Gets a `ClassReaderSource` which is similar to that of `getClassSource()`, except that it also contains classes with applied transformations together with classes, generated via `DependencyChecker.submitClass(ClassHolder)`.
`DependencyInfo`	`getDependencyInfo()`
`Collection<MethodReference>`	`getMethods()`
`ProblemProvider`	`getProblemProvider()`
`ProgramCache`	`getProgramCache()`
`TeaVMProgressListener`	`getProgressListener()`
`Properties`	`getProperties()` Gets configuration properties.
`<T> T`	`getService(Class<T> type)`
`ListableClassReaderSource`	`getWrittenClasses()`
`void`	`installPlugins()` Finds and install all plugins in the current class path.
`boolean`	`isBytecodeLogging()`
`boolean`	`isIncremental()`
`boolean`	`isMinifying()` Reports whether this TeaVM instance uses obfuscation when generating the JavaScript code.
`ListableClassHolderSource`	`link(DependencyInfo dependency)`
`TeaVMEntryPoint`	`linkMethod(MethodReference ref)`
`void`	`linkType(String className)`
`<T> void`	`registerService(Class<T> type, T instance)`
`void`	`setAstCache(MethodNodeCache methodAstCache)`
`void`	`setBytecodeLogging(boolean bytecodeLogging)`
`void`	`setDebugEmitter(DebugInformationEmitter debugEmitter)`
`void`	`setIncremental(boolean incremental)`
`void`	`setMinifying(boolean minifying)` Specifies whether this TeaVM instance uses obfuscation when generating the JavaScript code.
`void`	`setProgramCache(ProgramCache programCache)`
`void`	`setProgressListener(TeaVMProgressListener progressListener)`
`void`	`setProperties(Properties properties)` Specifies configuration properties for TeaVM and its plugins.
`boolean`	`wasCancelled()`

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

- Method Detail
  - add
```
public void add(DependencyListener listener)
```
    Specified by:
    
    add in interface TeaVMHost
  - add
```
public void add(ClassHolderTransformer transformer)
```
    Specified by:
    
    add in interface TeaVMHost
  - add
```
public void add(MethodReference methodRef,
                Generator generator)
```
    Specified by:
    
    add in interface TeaVMHost
  - add
```
public void add(MethodReference methodRef,
                Injector injector)
```
    Specified by:
    
    add in interface TeaVMHost
  - add
```
public void add(RendererListener listener)
```
    Specified by:
    
    add in interface TeaVMHost
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Description copied from interface: TeaVMHost
    
    Gets class loaded that is used by TeaVM. This class loader is usually specified by TeaVMBuilder.setClassLoader(ClassLoader)
    
    Specified by:
    
    getClassLoader in interface TeaVMHost
    
    Returns:
    
    class loader that can be used by plugins.
  - isMinifying
```
public boolean isMinifying()
```
    Reports whether this TeaVM instance uses obfuscation when generating the JavaScript code.
    
    Returns:
    
    whether TeaVM produces obfuscated code.
    
    See Also:
    
    setMinifying(boolean)
  - setMinifying
```
public void setMinifying(boolean minifying)
```
    Specifies whether this TeaVM instance uses obfuscation when generating the JavaScript code.
    
    Parameters:
    
    minifying - whether TeaVM should obfuscate code.
    
    See Also:
    
    isMinifying()
  - isBytecodeLogging
```
public boolean isBytecodeLogging()
```
  - setBytecodeLogging
```
public void setBytecodeLogging(boolean bytecodeLogging)
```
  - setProperties
```
public void setProperties(Properties properties)
```
    Specifies configuration properties for TeaVM and its plugins. You should call this method before installing any plugins or interceptors.
    
    Parameters:
    
    properties - configuration properties to set. These properties will be copied into this VM instance, so VM won't see any further changes in this object.
  - getProperties
```
public Properties getProperties()
```
    Description copied from interface: TeaVMHost
    
    Gets configuration properties. These properties are usually specified by setProperties(Properties).
    
    Specified by:
    
    getProperties in interface TeaVMHost
    
    Returns:
    
    a copy of all of the VM properties. Any further changes to returned objects will not be visible to VM.
  - getAstCache
```
public MethodNodeCache getAstCache()
```
  - setAstCache
```
public void setAstCache(MethodNodeCache methodAstCache)
```
  - getProgramCache
```
public ProgramCache getProgramCache()
```
  - setProgramCache
```
public void setProgramCache(ProgramCache programCache)
```
  - isIncremental
```
public boolean isIncremental()
```
  - setIncremental
```
public void setIncremental(boolean incremental)
```
  - getProgressListener
```
public TeaVMProgressListener getProgressListener()
```
  - setProgressListener
```
public void setProgressListener(TeaVMProgressListener progressListener)
```
  - wasCancelled
```
public boolean wasCancelled()
```
  - getProblemProvider
```
public ProblemProvider getProblemProvider()
```
  - entryPoint
```
public TeaVMEntryPoint entryPoint(String name,
                                  MethodReference ref)
```
    Adds an entry point. TeaVM guarantees, that all methods that are required by the entry point will be available at run-time in browser. Also you need to specify for each parameter of entry point which actual types will be passed here by calling TeaVMEntryPoint.withValue(int, String). It is highly recommended to read explanation on TeaVMEntryPoint class documentation.
    
    You should call this method after installing all plugins and interceptors, but before doing the actual build.
    
    Parameters:
    
    name - the name under which this entry point will be available for JavaScript code.
    
    ref - a full reference to the method which is an entry point.
    
    Returns:
    
    an entry point that you can additionally adjust.
  - entryPoint
```
public TeaVMEntryPoint entryPoint(MethodReference ref)
```
    Adds an entry point. TeaVM guarantees, that all methods that are required by the entry point will be available at run-time in browser. Also you need to specify for each parameter of entry point which actual types will be passed here by calling TeaVMEntryPoint.withValue(int, String). It is highly recommended to read explanation on TeaVMEntryPoint class documentation.
    
    You should call this method after installing all plugins and interceptors, but before doing the actual build.
    
    Parameters:
    
    ref - a full reference to the method which is an entry point.
    
    Returns:
    
    an entry point that you can additionally adjust.
  - linkMethod
```
public TeaVMEntryPoint linkMethod(MethodReference ref)
```
  - exportType
```
public void exportType(String name,
                       String className)
```
  - linkType
```
public void linkType(String className)
```
  - getClassSource
```
public ClassReaderSource getClassSource()
```
    Gets a ClassReaderSource which is used by this TeaVM instance. It is exactly what was passed to TeaVMBuilder.setClassSource(ClassHolderSource).
    
    Returns:
    
    class source.
  - getDependencyClassSource
```
public ClassReaderSource getDependencyClassSource()
```
    Gets a ClassReaderSource which is similar to that of getClassSource(), except that it also contains classes with applied transformations together with classes, generated via DependencyChecker.submitClass(ClassHolder).
  - getClasses
```
public Collection<String> getClasses()
```
  - getMethods
```
public Collection<MethodReference> getMethods()
```
  - getDependencyInfo
```
public DependencyInfo getDependencyInfo()
```
  - getWrittenClasses
```
public ListableClassReaderSource getWrittenClasses()
```
  - getDebugEmitter
```
public DebugInformationEmitter getDebugEmitter()
```
  - setDebugEmitter
```
public void setDebugEmitter(DebugInformationEmitter debugEmitter)
```
  - build
```
public void build(Appendable writer,
                  BuildTarget target)
           throws RenderingException
```
    Does actual build. Call this method after TeaVM is fully configured and all entry points are specified. This method may fail if there are items (classes, methods and fields) that are required by entry points, but weren't found in classpath. In this case no actual generation happens and no exceptions thrown, but you can further call getProblemProvider() to learn the build state.
    
    Parameters:
    
    writer - where to generate JavaScript. Should not be null.
    
    target - where to generate additional resources. Can be null, but if there are plugins or inteceptors that generate additional resources, the build process will fail.
    
    Throws:
    
    RenderingException - when something went wrong during rendering phase.
  - link
```
public ListableClassHolderSource link(DependencyInfo dependency)
```
  - build
```
public void build(File dir,
                  String fileName)
           throws RenderingException
```
    Throws:
    
    RenderingException
  - installPlugins
```
public void installPlugins()
```
    Finds and install all plugins in the current class path. The standard ServiceLoader approach is used to find plugins. So this method scans all META-INF/services/org.teavm.vm.spi.TeaVMPlugin resources and obtains all implementation classes that are enumerated there.
  - getService
```
public <T> T getService(Class<T> type)
```
    Specified by:
    
    getService in interface ServiceRepository
  - registerService
```
public <T> void registerService(Class<T> type,
                                T instance)
```
    Specified by:
    
    registerService in interface TeaVMHost

Class TeaVM

Method Summary

Methods inherited from class java.lang.Object

Method Detail

add

add

add

add

add

getClassLoader

isMinifying

setMinifying

isBytecodeLogging

setBytecodeLogging

setProperties

getProperties

getAstCache

setAstCache

getProgramCache

setProgramCache

isIncremental

setIncremental

getProgressListener

setProgressListener

wasCancelled

getProblemProvider

entryPoint

entryPoint

linkMethod

exportType

linkType

getClassSource

getDependencyClassSource

getClasses

getMethods

getDependencyInfo

getWrittenClasses

getDebugEmitter

setDebugEmitter

build

link

build

installPlugins

getService

registerService