VirtualMachine (Jenesis 4 Java Code Generator 2.19 API)

java.lang.Object
- net.sourceforge.jenesis4java.VirtualMachine

Direct Known Subclasses:

MVM
```
public abstract class VirtualMachine
extends Object
```
The VirtualMachine acts as a factory method for CompilationUnit, Type, Literal, and Expression objects. Most Statement factory methods are located on Block; most Declaration factory methods are located on the objects that contain them.

Constructor Summary

Constructors
Constructor and Description

VirtualMachine()

Constructors
Constructor and Description
`VirtualMachine()`

Method Summary

Methods
Modifier and Type	Method and Description
`abstract VirtualMachine`	`clear()` Removes all cached compilationUnits.
`abstract VirtualMachine`	`encode()` Writes out the source code to all enclosed `CompilationUnit` instances.
`abstract CompilationUnitEncoder`	`getEncoder()`
`static VirtualMachine`	`getVirtualMachine()` Returns the default `VirtualMachine` implementation previously set using the static `setVirtualMachine(VirtualMachine)` method OR returns the reference implementation ( `com.inxar.jenesis.MVM`.
`abstract FieldAccess`	`newAccess(Class<?> qualifierClass, Object object)`
`abstract FieldAccess`	`newAccess(Expression qualifier, String name)` `Expression` factory method which returns a new field access with the given qualifier and name.
`abstract FieldAccess`	`newAccess(String name)` `Expression` factory method which returns a new field access with the given qualifier and name.
`abstract FieldAccess`	`newAccess(String qualifier, String name)` `Expression` factory method which returns a new field access with the given qualifier and name.
`abstract Annotation`	`newAnnotation(Class<?> annotationClass)`
`abstract Annotation`	`newAnnotation(String text)` Creates a new annotation with the given name.
`abstract AnnotationAttribute`	`newAnnotationAttribute(String key, Expression value, Expression... additionalValues)` Creates a new annotation attribute with the given name and the given value.
`abstract NewAnonymousClass`	`newAnon(Type type)` `Expression` factory method which returns a new anonymous class instance creation expression for the given type.
`abstract NewAnonymousClass`	`newAnon(Type type, Comparator comparator)`
`abstract NewAnonymousClass`	`newAnonymousClass(String className, Comparator comparator, String... genericTypes)`
`abstract NewAnonymousClass`	`newAnonymousClass(String className, String... genericTypes)`
`abstract ArrayType`	`newArray(int type, int dims)` `Type` factory method which returns an array of primitive type with the given constant and dimensions.
`abstract ArrayType`	`newArray(String type, int dims)` `Type` factory method which returns an array of class type with the given name and dimensions.
`abstract NewArray`	`newArray(Type type)` `Expression` factory method which returns a new array instance creation expression for the given type.
`abstract ArrayAccess`	`newArrayAccess(Expression qual, String name)` `Expression` factory method which returns a new array access expression with the given qualifier and name.
`abstract ArrayAccess`	`newArrayAccess(String name)` `Expression` factory method which returns a new array access expression with the given qualifier and name.
`abstract ArrayAccess`	`newArrayAccess(String qual, String name)` `Expression` factory method which returns a new array access expression with the given qualifier and name.
`abstract ArrayInitializer`	`newArrayInit(Expression[] expressions)` `Expression` factory method which returns a new array initializer with the given arguments.
`abstract ArrayInitializer`	`newArrayInit(Object o)` `Expression` factory method which returns a new array initializer with the given arguments.
`abstract Assign`	`newAssign(int type, Variable left, Expression right)` `Expression` factory method which returns a new assignment of the given type.
`abstract Assign`	`newAssign(Variable left, Expression right)` `Expression` factory method which returns a new assignment of the SIMPLE type.
`abstract Binary`	`newBinary(int type, Expression left, Expression right)` `Expression` factory method which returns a new unary function of the given type.
`abstract Blank`	`newBlank()` `Expression` factory method which returns the blank expression.
`abstract BooleanLiteral`	`newBoolean(boolean value)` `Literal` factory method which returns a new `boolean` literal.
`abstract Cast`	`newBrackets(Expression value)` `Expression` factory method which returns a new expression that wraps brackets around the expression.
`abstract ByteLiteral`	`newByte(byte val)` `Literal` factory method which returns a new `byte` literal.
`abstract CalendarClassType`	`newCalendarType(String pattern)` `Type` factory method which returns a calendar type with the given pattern as representation storage.
`abstract Cast`	`newCast(Type type, Expression value)` `Expression` factory method which returns a new cast function having the given type and value.
`abstract CharLiteral`	`newChar(char val)` `Literal` factory method which returns a new `char` literal.
`abstract NewClass`	`newClass(Type type)` `Expression` factory method which returns a new class instance creation expression for the given type.
`abstract ClassLiteral`	`newClassLiteral(ClassType type)` `Literal` factory method which returns a new `Class` literal.
`abstract ClassLiteral`	`newClassLiteral(String className)` `Literal` factory method which returns a new `Class` literal.
`abstract CompilationUnit`	`newCompilationUnit(String sourcepath)` Creates a new `CompilationUnit` in this `Machine` and returns it.
`abstract CompilationUnit`	`newCompilationUnit(String sourceDirectory, String packageName)` Creates a new `CompilationUnit` in this `Machine` sets the namespace and returns it.
`abstract DoubleLiteral`	`newDouble(double val)` `Literal` factory method which returns a new `double` literal.
`abstract False`	`newFalse()` `Literal` factory method which returns the boolean `false` literal.
`abstract FloatLiteral`	`newFloat(float val)` `Literal` factory method which returns a new `float` literal.
`abstract Freeform`	`newFree(String code)` `Expression` factory method which returns a new freeform expression with the given code.
`abstract IntLiteral`	`newInt(int val)` `Literal` factory method which returns a new `int` literal.
`abstract Invoke`	`newInvoke(Class<?> qualifyingClass, String name)`
`abstract Invoke`	`newInvoke(Expression qualifier, String name)` `Expression` factory method which returns a new method invocation with the given qualifier and name.
`abstract Invoke`	`newInvoke(String name)` `Expression` factory method which returns a new method invocation with the given qualifier and name.
`abstract Invoke`	`newInvoke(String qualifier, String name)` `Expression` factory method which returns a new method invocation with the given qualifier and name.
`abstract LongLiteral`	`newLong(long val)` `Literal` factory method which returns a new `long` literal.
`abstract Null`	`newNull()` `Literal` factory method which returns the `null` literal.
`abstract OctalLiteral`	`newOctal(char val)` `Literal` factory method which returns a new octal `char` literal.
`abstract ScientificLiteral`	`newScientific(int precision, int scale, int exponent)` `Literal` factory method which returns a new scientific floating point `char` literal.
`abstract ShortLiteral`	`newShort(short val)` `Literal` factory method which returns a new `short` literal.
`abstract ClassType`	`newSimpleType(Class<?> type)`
`abstract StringLiteral`	`newString(String val)` `Literal` factory method which returns a new `String` literal.
`abstract Super`	`newSuper()`
`abstract Ternary`	`newTernary(int type, Expression one, Expression two, Expression three)` `Expression` factory method which returns a new unary function of the given type.
`abstract This`	`newThis()`
`abstract This`	`newThis(ClassType typeOfOuterClass)`
`abstract True`	`newTrue()` `Literal` factory method which returns the boolean `true` literal.
`abstract ClassType`	`newType(Class<?> clazz)` `Type` factory method which returns a class type named with the given `Class`.
`abstract PrimitiveType`	`newType(int type)` `Type` factory method which returns a primitive type named by the given `int` as allowed by the constants listed in the `Type` interface.
`abstract ClassType`	`newType(String name)` `Type` factory method which returns a class type named with the given `String`.
`abstract Unary`	`newUnary(int type, Expression value)` `Expression` factory method which returns a new unary function of the given type.
`abstract UnicodeLiteral`	`newUnicode(char val)` `Literal` factory method which returns a new unicode `char` literal.
`abstract Variable`	`newVar(String name)` `Expression` factory method which returns a new variable with the given name.
`abstract Variable`	`newVar(Type type)` `Expression` factory method which returns a new variable with the given name.
`static VirtualMachine`	`setVirtualMachine(VirtualMachine vm)` Sets the default `VirtualMachine` implementation.
`abstract Type`	`type_boolean()`
`abstract Type`	`type_byte()`
`abstract Type`	`type_char()`
`abstract Type`	`type_double()`
`abstract Type`	`type_float()`
`abstract Type`	`type_int()`
`abstract Type`	`type_long()`
`abstract Type`	`type_short()`
`abstract Type`	`type_void()`
`abstract ClassType`	`typeBigDecimal()`
`abstract ClassType`	`typeBoolean()`
`abstract ClassType`	`typeCalendar()`
`abstract ClassType`	`typeInteger()`
`abstract ClassType`	`typeLong()`
`abstract ClassType`	`typeString()`

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

- Constructor Detail
  - VirtualMachine
```
public VirtualMachine()
```
- Method Detail
  - getVirtualMachine
```
public static VirtualMachine getVirtualMachine()
```
    Returns the default VirtualMachine implementation previously set using the static setVirtualMachine(VirtualMachine) method OR returns the reference implementation ( com.inxar.jenesis.MVM.
    
    The settings for the coding style are read from the file specified by the system property "jenesis.blockstyle-properties-filename" (a real file or available in the classpath). If there was non specified, a fall back to /META-INF/blockstyle.properties will be used.
    
    All properties may be overwritten by specifying them in the system properties with a "jenesis." prefix.
    For example you can specify to use the net.sourceforge.jenesis4java.jaloppy.JenesisJalopyEncoder encoder by setting the property "jenesis.encoder" and "jenesis.encoder.jalopyconfig"
  - setVirtualMachine
```
public static VirtualMachine setVirtualMachine(VirtualMachine vm)
```
    Sets the default VirtualMachine implementation.
  - clear
```
public abstract VirtualMachine clear()
```
    Removes all cached compilationUnits.
  - encode
```
public abstract VirtualMachine encode()
```
    Writes out the source code to all enclosed CompilationUnit instances.
  - getEncoder
```
public abstract CompilationUnitEncoder getEncoder()
```
    Returns:
    the current active encoder.
  - newAccess
```
public abstract FieldAccess newAccess(Class<?> qualifierClass,
                    Object object)
```
  - newAccess
```
public abstract FieldAccess newAccess(Expression qualifier,
                    String name)
```
    Expression factory method which returns a new field access with the given qualifier and name.
  - newAccess
```
public abstract FieldAccess newAccess(String name)
```
    Expression factory method which returns a new field access with the given qualifier and name.
  - newAccess
```
public abstract FieldAccess newAccess(String qualifier,
                    String name)
```
    Expression factory method which returns a new field access with the given qualifier and name.
  - newAnnotation
```
public abstract Annotation newAnnotation(Class<?> annotationClass)
```
  - newAnnotation
```
public abstract Annotation newAnnotation(String text)
```
    Creates a new annotation with the given name. For a given name "Example" this will result in an annotation @Example.
    
    Parameters:
    text - The name of the annotation. Must not start with "@".
    
    Returns:
    The newly created Annotation.
  - newAnnotationAttribute
```
public abstract AnnotationAttribute newAnnotationAttribute(String key,
                                         Expression value,
                                         Expression... additionalValues)
```
    Creates a new annotation attribute with the given name and the given value.
    
    Returns:
    The newly created annotation attribute.
  - newAnon
```
public abstract NewAnonymousClass newAnon(Type type)
```
    Expression factory method which returns a new anonymous class instance creation expression for the given type.
  - newAnon
```
public abstract NewAnonymousClass newAnon(Type type,
                        Comparator comparator)
```
  - newAnonymousClass
```
public abstract NewAnonymousClass newAnonymousClass(String className,
                                  String... genericTypes)
```
  - newAnonymousClass
```
public abstract NewAnonymousClass newAnonymousClass(String className,
                                  Comparator comparator,
                                  String... genericTypes)
```
  - newArray
```
public abstract ArrayType newArray(int type,
                 int dims)
```
    Type factory method which returns an array of primitive type with the given constant and dimensions.
  - newArray
```
public abstract ArrayType newArray(String type,
                 int dims)
```
    Type factory method which returns an array of class type with the given name and dimensions.
  - newArray
```
public abstract NewArray newArray(Type type)
```
    Expression factory method which returns a new array instance creation expression for the given type.
  - newArrayAccess
```
public abstract ArrayAccess newArrayAccess(Expression qual,
                         String name)
```
    Expression factory method which returns a new array access expression with the given qualifier and name.
  - newArrayAccess
```
public abstract ArrayAccess newArrayAccess(String name)
```
    Expression factory method which returns a new array access expression with the given qualifier and name.
  - newArrayAccess
```
public abstract ArrayAccess newArrayAccess(String qual,
                         String name)
```
    Expression factory method which returns a new array access expression with the given qualifier and name.
  - newArrayInit
```
public abstract ArrayInitializer newArrayInit(Expression[] expressions)
```
    Expression factory method which returns a new array initializer with the given arguments.
  - newArrayInit
```
public abstract ArrayInitializer newArrayInit(Object o)
```
    Expression factory method which returns a new array initializer with the given arguments.
  - newAssign
```
public abstract Assign newAssign(int type,
               Variable left,
               Expression right)
```
    Expression factory method which returns a new assignment of the given type.
  - newAssign
```
public abstract Assign newAssign(Variable left,
               Expression right)
```
    Expression factory method which returns a new assignment of the SIMPLE type. This is a convenience * method.
  - newBinary
```
public abstract Binary newBinary(int type,
               Expression left,
               Expression right)
```
    Expression factory method which returns a new unary function of the given type.
  - newBlank
```
public abstract Blank newBlank()
```
    Expression factory method which returns the blank expression.
  - newBoolean
```
public abstract BooleanLiteral newBoolean(boolean value)
```
    Literal factory method which returns a new boolean literal.
  - newBrackets
```
public abstract Cast newBrackets(Expression value)
```
    Expression factory method which returns a new expression that wraps brackets around the expression.
  - newByte
```
public abstract ByteLiteral newByte(byte val)
```
    Literal factory method which returns a new byte literal.
  - newCalendarType
```
public abstract CalendarClassType newCalendarType(String pattern)
```
    Type factory method which returns a calendar type with the given pattern as representation storage.
  - newCast
```
public abstract Cast newCast(Type type,
           Expression value)
```
    Expression factory method which returns a new cast function having the given type and value.
  - newChar
```
public abstract CharLiteral newChar(char val)
```
    Literal factory method which returns a new char literal.
  - newClass
```
public abstract NewClass newClass(Type type)
```
    Expression factory method which returns a new class instance creation expression for the given type.
  - newClassLiteral
```
public abstract ClassLiteral newClassLiteral(ClassType type)
```
    Literal factory method which returns a new Class literal.
  - newClassLiteral
```
public abstract ClassLiteral newClassLiteral(String className)
```
    Literal factory method which returns a new Class literal.
  - newCompilationUnit
```
public abstract CompilationUnit newCompilationUnit(String sourcepath)
```
    Creates a new CompilationUnit in this Machine and returns it.
  - newCompilationUnit
```
public abstract CompilationUnit newCompilationUnit(String sourceDirectory,
                                 String packageName)
```
    Creates a new CompilationUnit in this Machine sets the namespace and returns it.
  - newDouble
```
public abstract DoubleLiteral newDouble(double val)
```
    Literal factory method which returns a new double literal.
  - newFalse
```
public abstract False newFalse()
```
    Literal factory method which returns the boolean false literal.
  - newFloat
```
public abstract FloatLiteral newFloat(float val)
```
    Literal factory method which returns a new float literal.
  - newFree
```
public abstract Freeform newFree(String code)
```
    Expression factory method which returns a new freeform expression with the given code.
  - newInt
```
public abstract IntLiteral newInt(int val)
```
    Literal factory method which returns a new int literal.
  - newInvoke
```
public abstract Invoke newInvoke(Class<?> qualifyingClass,
               String name)
```
  - newInvoke
```
public abstract Invoke newInvoke(Expression qualifier,
               String name)
```
    Expression factory method which returns a new method invocation with the given qualifier and name.
  - newInvoke
```
public abstract Invoke newInvoke(String name)
```
    Expression factory method which returns a new method invocation with the given qualifier and name.
  - newInvoke
```
public abstract Invoke newInvoke(String qualifier,
               String name)
```
    Expression factory method which returns a new method invocation with the given qualifier and name.
  - newLong
```
public abstract LongLiteral newLong(long val)
```
    Literal factory method which returns a new long literal.
  - newNull
```
public abstract Null newNull()
```
    Literal factory method which returns the null literal.
  - newOctal
```
public abstract OctalLiteral newOctal(char val)
```
    Literal factory method which returns a new octal char literal.
  - newScientific
```
public abstract ScientificLiteral newScientific(int precision,
                              int scale,
                              int exponent)
```
    Literal factory method which returns a new scientific floating point char literal.
  - newShort
```
public abstract ShortLiteral newShort(short val)
```
    Literal factory method which returns a new short literal.
  - newSimpleType
```
public abstract ClassType newSimpleType(Class<?> type)
```
  - newString
```
public abstract StringLiteral newString(String val)
```
    Literal factory method which returns a new String literal.
  - newTernary
```
public abstract Ternary newTernary(int type,
                 Expression one,
                 Expression two,
                 Expression three)
```
    Expression factory method which returns a new unary function of the given type.
  - newTrue
```
public abstract True newTrue()
```
    Literal factory method which returns the boolean true literal.
  - newType
```
public abstract ClassType newType(Class<?> clazz)
```
    Type factory method which returns a class type named with the given Class.
  - newType
```
public abstract PrimitiveType newType(int type)
```
    Type factory method which returns a primitive type named by the given int as allowed by the constants listed in the Type interface.
    
    Parameters:
    type - A primitive type constant. Must not be array or class.
  - newType
```
public abstract ClassType newType(String name)
```
    Type factory method which returns a class type named with the given String.
  - newUnary
```
public abstract Unary newUnary(int type,
             Expression value)
```
    Expression factory method which returns a new unary function of the given type.
  - newUnicode
```
public abstract UnicodeLiteral newUnicode(char val)
```
    Literal factory method which returns a new unicode char literal.
  - newVar
```
public abstract Variable newVar(String name)
```
    Expression factory method which returns a new variable with the given name.
  - newVar
```
public abstract Variable newVar(Type type)
```
    Expression factory method which returns a new variable with the given name.
  - newThis
```
public abstract This newThis()
```
  - newThis
```
public abstract This newThis(ClassType typeOfOuterClass)
```
  - type_boolean
```
public abstract Type type_boolean()
```
    Returns:
    type representing:
  - type_byte
```
public abstract Type type_byte()
```
    Returns:
    type representing:
  - type_char
```
public abstract Type type_char()
```
    Returns:
    type representing:
  - type_double
```
public abstract Type type_double()
```
    Returns:
    type representing:
  - type_float
```
public abstract Type type_float()
```
    Returns:
    type representing:
  - type_int
```
public abstract Type type_int()
```
    Returns:
    type representing:
  - type_long
```
public abstract Type type_long()
```
    Returns:
    type representing:
  - type_short
```
public abstract Type type_short()
```
    Returns:
    type representing:
  - type_void
```
public abstract Type type_void()
```
    Returns:
    type representing:
  - typeBigDecimal
```
public abstract ClassType typeBigDecimal()
```
    Returns:
    type representing:
  - typeBoolean
```
public abstract ClassType typeBoolean()
```
    Returns:
    type representing:
  - typeCalendar
```
public abstract ClassType typeCalendar()
```
    Returns:
    type representing:
  - typeInteger
```
public abstract ClassType typeInteger()
```
    Returns:
    type representing:
  - typeLong
```
public abstract ClassType typeLong()
```
    Returns:
    type representing:
  - typeString
```
public abstract ClassType typeString()
```
    Returns:
    type representing:
  - newSuper
```
public abstract Super newSuper()
```

Class VirtualMachine

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VirtualMachine

Method Detail

getVirtualMachine

setVirtualMachine

clear

encode

getEncoder

newAccess

newAccess

newAccess

newAccess

newAnnotation

newAnnotation

newAnnotationAttribute

newAnon

newAnon

newAnonymousClass

newAnonymousClass

newArray

newArray

newArray

newArrayAccess

newArrayAccess

newArrayAccess

newArrayInit

newArrayInit

newAssign

newAssign

newBinary

newBlank

newBoolean

newBrackets

newByte

newCalendarType

newCast

newChar

newClass

newClassLiteral

newClassLiteral

newCompilationUnit

newCompilationUnit

newDouble

newFalse

newFloat

newFree

newInt

newInvoke

newInvoke

newInvoke

newInvoke

newLong

newNull

newOctal

newScientific

newShort

newSimpleType

newString

newTernary

newTrue

newType

newType

newType

newUnary

newUnicode

newVar

newVar

newThis

newThis

type_boolean

type_byte

type_char

type_double

type_float

type_int

type_long