Package net.officefloor.compile.classes

Class OfficeFloorJavaCompiler

java.lang.Object

net.officefloor.compile.classes.OfficeFloorJavaCompiler

Direct Known Subclasses:

OfficeFloorJavaCompilerImpl

public abstract class OfficeFloorJavaCompiler
extends Object

Java compiler to avoid Proxy implementations.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OfficeFloorJavaCompiler.ClassField	Class Field.
static interface	OfficeFloorJavaCompiler.ClassName	Class name.
static interface	OfficeFloorJavaCompiler.ConstructorWriter	Writes the Constructor for the wrapping implementation.
static interface	OfficeFloorJavaCompiler.ConstructorWriterContext	Context for the OfficeFloorJavaCompiler.ConstructorWriter.
static interface	OfficeFloorJavaCompiler.ImplementationRunnable<T extends Throwable>	Runnable to use with the specified OfficeFloorJavaCompiler implementation.
static interface	OfficeFloorJavaCompiler.JavaSource	Java source.
static interface	OfficeFloorJavaCompiler.JavaSourceContext	Context for the OfficeFloorJavaCompiler.JavaSourceWriter.
static interface	OfficeFloorJavaCompiler.JavaSourceWriter	Provides means to including source.
static interface	OfficeFloorJavaCompiler.MethodWriter	Writes each Method required by implementing interfaces.
static interface	OfficeFloorJavaCompiler.MethodWriterContext	Context for the OfficeFloorJavaCompiler.MethodWriterContext.
static interface	OfficeFloorJavaCompiler.NonCompilerOperation<T extends Throwable>	Operation undertaken without the Java compiler being available.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_OFFICE_FLOOR_JAVA_COMPILER_IMPLEMENTATION	Default OfficeFloorJavaCompiler implementation Class name.
static final String	SYSTEM_PROPERTY_JAVA_COMPILING	System property to indicate if Java compiling active for OfficeFloor.

Constructor Summary

Constructors

Constructor	Description
OfficeFloorJavaCompiler()

Method Summary

Modifier and Type	Method	Description
abstract OfficeFloorJavaCompiler.JavaSource	addSource(String className, String source)	Adds a OfficeFloorJavaCompiler.JavaSource.
OfficeFloorJavaCompiler.JavaSource	addSource(OfficeFloorJavaCompiler.ClassName className, String source)	Adds a OfficeFloorJavaCompiler.JavaSource.
abstract OfficeFloorJavaCompiler.JavaSource	addWrapper(Class<?>[] wrappingTypes, Class<?> delegateType, String delegateExtraction, OfficeFloorJavaCompiler.ConstructorWriter constructorWriter, OfficeFloorJavaCompiler.MethodWriter methodWriter, OfficeFloorJavaCompiler.JavaSourceWriter... additionalSourceWriter)	Adds a wrapper OfficeFloorJavaCompiler.JavaSource.
OfficeFloorJavaCompiler.JavaSource	addWrapper(Class<?> type, OfficeFloorJavaCompiler.MethodWriter methodWriter, OfficeFloorJavaCompiler.JavaSourceWriter... additionalSourceWriter)	Adds a wrapper OfficeFloorJavaCompiler.JavaSource.
abstract Map<OfficeFloorJavaCompiler.JavaSource,Class<?>>	compile()	Compiles all the added OfficeFloorJavaCompiler.JavaSource instances.
abstract OfficeFloorJavaCompiler.ClassName	createClassName(String name)	Generates a unique OfficeFloorJavaCompiler.ClassName.
abstract OfficeFloorJavaCompiler.ClassField	createField(Class<?> fieldType, String fieldName)	Creates the OfficeFloorJavaCompiler.ClassField.
abstract String	getSourceName(Class<?> type)	Obtains the source name for the Class.
static OfficeFloorJavaCompiler	newInstance(SourceContext sourceContext)	Creates a new instance of the OfficeFloorJavaCompiler.
static <T extends Throwable> void	runWithImplementation(String officeFloorJavaCompilerImplementationClassName, OfficeFloorJavaCompiler.ImplementationRunnable<T> runnable)	Runs with a particular OfficeFloorJavaCompiler implementation.
static <T extends Throwable> void	runWithoutCompiler(OfficeFloorJavaCompiler.NonCompilerOperation<T> operation)	Undertakes the OfficeFloorJavaCompiler.NonCompilerOperation without making the Java compiler available.
abstract void	writeConstructor(Appendable appendable, String className, OfficeFloorJavaCompiler.ClassField... fields)	Writes the Constructor.
abstract void	writeDelegateMethodCall(Appendable source, String delegate, Method method)	Writes the delegate Method call.
abstract void	writeMethodImplementation(Appendable source, String delegate, Method method)	Writes the Method implementation by invoking the delegate.
abstract boolean	writeMethodSignature(Appendable appendable, Method method)	Writes the Method signature to the Appendable.

Methods inherited from class java.lang.Object

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

Field Details

SYSTEM_PROPERTY_JAVA_COMPILING

public static final String SYSTEM_PROPERTY_JAVA_COMPILING

System property to indicate if Java compiling active for OfficeFloor.

See Also:

• Constant Field Values

DEFAULT_OFFICE_FLOOR_JAVA_COMPILER_IMPLEMENTATION

public static final String DEFAULT_OFFICE_FLOOR_JAVA_COMPILER_IMPLEMENTATION

Default OfficeFloorJavaCompiler implementation Class name.

See Also:

• Constant Field Values

Constructor Details

OfficeFloorJavaCompiler

public OfficeFloorJavaCompiler()

Method Details

runWithImplementation

public static <T extends Throwable> void runWithImplementation(String officeFloorJavaCompilerImplementationClassName,
 OfficeFloorJavaCompiler.ImplementationRunnable<T> runnable)
                                                        throws T

Runs with a particular OfficeFloorJavaCompiler implementation.

Type Parameters:

T - Throwable type.

Parameters:

officeFloorJavaCompilerImplementationClassName - Class name of the OfficeFloorJavaCompiler implementation.

runnable - OfficeFloorJavaCompiler.ImplementationRunnable.

Throws:

T - Possible Throwable from OfficeFloorJavaCompiler.ImplementationRunnable.

newInstance

public static OfficeFloorJavaCompiler newInstance(SourceContext sourceContext)

Creates a new instance of the OfficeFloorJavaCompiler.

Parameters:

sourceContext - SourceContext.

Returns:

OfficeFloorJavaCompiler or null if Java compiling not available.

runWithoutCompiler

public static <T extends Throwable> void runWithoutCompiler(OfficeFloorJavaCompiler.NonCompilerOperation<T> operation)
                                                     throws T

Undertakes the OfficeFloorJavaCompiler.NonCompilerOperation without making the Java compiler available.

This is useful for testing non Java compile solutions.

Type Parameters:

T - Possible Throwable type.

Parameters:

operation - OfficeFloorJavaCompiler.NonCompilerOperation.

Throws:

T - Possible failure.

createClassName

public abstract OfficeFloorJavaCompiler.ClassName createClassName(String name)

Generates a unique OfficeFloorJavaCompiler.ClassName.

Parameters:

name - Seed name.

Returns:

OfficeFloorJavaCompiler.ClassName.

getSourceName

public abstract String getSourceName(Class<?> type)

Obtains the source name for the Class.

Parameters:

type - Class.

Returns:

Name used in source to reference the type.

createField

public abstract OfficeFloorJavaCompiler.ClassField createField(Class<?> fieldType,
 String fieldName)

Creates the OfficeFloorJavaCompiler.ClassField.

Parameters:

fieldType - Field type.

fieldName - Field name.

Returns:

OfficeFloorJavaCompiler.ClassField.

writeConstructor

public abstract void writeConstructor(Appendable appendable,
 String className,
 OfficeFloorJavaCompiler.ClassField... fields)
                               throws IOException

Writes the Constructor.

Parameters:

appendable - Appendable.

className - Simple name of the Class.

fields - OfficeFloorJavaCompiler.ClassField instances.

Throws:

IOException - If fails to write the Constructor.

writeMethodSignature

public abstract boolean writeMethodSignature(Appendable appendable,
 Method method)
                                      throws IOException

Writes the Method signature to the Appendable.

Parameters:

appendable - Appendable.

method - Method.

Returns:

true if returns a value (false for void Method return).

Throws:

IOException - If fails to write the Method signature.

writeDelegateMethodCall

public abstract void writeDelegateMethodCall(Appendable source,
 String delegate,
 Method method)
                                      throws IOException

Writes the delegate Method call.

Parameters:

source - Appendable.

delegate - Means to access delegate.

method - Method.

Throws:

IOException - If fails write delegate Method call.

writeMethodImplementation

public abstract void writeMethodImplementation(Appendable source,
 String delegate,
 Method method)
                                        throws IOException

Writes the Method implementation by invoking the delegate.

Parameters:

source - Appendable.

delegate - Means to access delegate.

method - Method.

Throws:

IOException - If fails write delegate Method implementation.

addSource

public OfficeFloorJavaCompiler.JavaSource addSource(OfficeFloorJavaCompiler.ClassName className,
 String source)

Adds a OfficeFloorJavaCompiler.JavaSource.

Parameters:

className - OfficeFloorJavaCompiler.ClassName.

source - Source for the Class.

Returns:

OfficeFloorJavaCompiler.JavaSource.

addSource

public abstract OfficeFloorJavaCompiler.JavaSource addSource(String className,
 String source)

Adds a OfficeFloorJavaCompiler.JavaSource.

Parameters:

className - Class name.

source - Source for the Class.

Returns:

OfficeFloorJavaCompiler.JavaSource.

addWrapper

public OfficeFloorJavaCompiler.JavaSource addWrapper(Class<?> type,
 OfficeFloorJavaCompiler.MethodWriter methodWriter,
 OfficeFloorJavaCompiler.JavaSourceWriter... additionalSourceWriter)
                                              throws IOException

Adds a wrapper OfficeFloorJavaCompiler.JavaSource.

Parameters:

type - Type being wrapped.

methodWriter - OfficeFloorJavaCompiler.MethodWriter. May be null to use default implementation.

additionalSourceWriter - OfficeFloorJavaCompiler.JavaSourceWriter instances.

Returns:

OfficeFloorJavaCompiler.JavaSource for the wrapper.

Throws:

IOException - If fails to write the wrapper.

addWrapper

public abstract OfficeFloorJavaCompiler.JavaSource addWrapper(Class<?>[] wrappingTypes,
 Class<?> delegateType,
 String delegateExtraction,
 OfficeFloorJavaCompiler.ConstructorWriter constructorWriter,
 OfficeFloorJavaCompiler.MethodWriter methodWriter,
 OfficeFloorJavaCompiler.JavaSourceWriter... additionalSourceWriter)
                                                       throws IOException

Adds a wrapper OfficeFloorJavaCompiler.JavaSource.

Parameters:

wrappingTypes - Wrapping types.

delegateType - Delegate type.

delegateExtraction - Means to extract the wrapped implementation from the delegate. May be null to use default.

constructorWriter - OfficeFloorJavaCompiler.ConstructorWriter. May be null to use default Constructor.

methodWriter - OfficeFloorJavaCompiler.MethodWriter. May be null to use default implementation.

additionalSourceWriter - OfficeFloorJavaCompiler.JavaSourceWriter instances.

Returns:

OfficeFloorJavaCompiler.JavaSource for the wrapper.

Throws:

IOException - If fails to write the wrapper.

compile

public abstract Map<OfficeFloorJavaCompiler.JavaSource,Class<?>> compile()

Compiles all the added OfficeFloorJavaCompiler.JavaSource instances.

Returns:

Map of OfficeFloorJavaCompiler.JavaSource to its Class.