org.jace.proxy

Class AutoProxy.Builder

java.lang.Object

org.jace.proxy.AutoProxy.Builder

Enclosing class:

AutoProxy

public static final class AutoProxy.Builder
extends Object

Creates a new AutoProxy.

Constructor Summary

Constructors

Constructor and Description
AutoProxy.Builder(Collection<File> inputHeaders, Collection<File> inputSources, File outputHeaders, File outputSources, ClassPath classPath) Creates a new AutoProxy.

Method Summary

Methods

Modifier and Type	Method and Description
AutoProxy.Builder	accessibility(ProxyGenerator.AccessibilityType accessibility) Indicates the method accessibility to expose.
AutoProxy.Builder	exportSymbols(boolean value) Indicates if proxy symbols should be exported (i.e.
AutoProxy.Builder	extraDependency(TypeName dependency) Specifies classes that should be exported in spite of the fact that they are not referenced by input files.
void	generateProxies() Generates the proxies.
AutoProxy.Builder	minimizeDependencies(boolean value) Indicates whether classes should be exported even if they are not referenced by the input files.

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoProxy.Builder

public AutoProxy.Builder(Collection<File> inputHeaders,
                 Collection<File> inputSources,
                 File outputHeaders,
                 File outputSources,
                 ClassPath classPath)
                  throws IllegalArgumentException

Creates a new AutoProxy.

Parameters:

inputHeaders - The directories to recursively search for header files

inputSources - The directories to recursively search for source files

outputHeaders - The directory to write new proxy header files to

outputSources - The directory to write new proxy source files to

classPath - The path to search for class files when resolving class dependencies

Throws:

IllegalArgumentException - If inputHeaders, inputSources, outputHeaders, outputSources, extraDependencies or classPath are null. Or if one of the inputHeaders/inputSources elements is not a directory or does not exist.

Method Detail

accessibility

public AutoProxy.Builder accessibility(ProxyGenerator.AccessibilityType accessibility)

Indicates the method accessibility to expose.

Parameters:

accessibility - The method accessibility to expose. The default is AccessibilityType.PUBLIC.

Returns:

the Builder

minimizeDependencies

public AutoProxy.Builder minimizeDependencies(boolean value)

Indicates whether classes should be exported even if they are not referenced by the input files.

Parameters:

value - true if the minimum set of classes should be generated (superclass, interfaces and any classes used by the input files). false if all class dependencies (arguments, return values, and fields) should be exported. The latter is used to generate proxies for a Java library, where the set of input files are not known ahead of time. The default is true.

Returns:

the Builder

extraDependency

public AutoProxy.Builder extraDependency(TypeName dependency)

Specifies classes that should be exported in spite of the fact that they are not referenced by input files. This is mechanism is only enabled when minimizeDependencies is true. When generating proxies for a Java library there is no way of knowing what classes will be referenced ahead of time so you must use this mechanism to specify any classes above those that are automatically determined.

Parameters:

dependency - A class that should be exported

Returns:

the Builder

exportSymbols

public AutoProxy.Builder exportSymbols(boolean value)

Indicates if proxy symbols should be exported (i.e. for use in DLLs)

Parameters:

value - true if proxy symbols should be exported. The default is false.

Returns:

the Builder

generateProxies

public void generateProxies()
                     throws IOException,
                            ClassNotFoundException

Generates the proxies.

Throws:

IOException - if an I/O exception occurs

ClassNotFoundException - if a class file cannot be found while generating proxies