com.google.gwt.dev

Class PermutationWorkerFactory

java.lang.Object

com.google.gwt.dev.PermutationWorkerFactory

Direct Known Subclasses:

ExternalPermutationWorkerFactory, ThreadedPermutationWorkerFactory

public abstract class PermutationWorkerFactory
extends Object

Represents a factory for implementations of an endpoint that will invoke CompilePerms. Implementations of PermutationWorkerFactory should be default-instantiable and will have init(com.google.gwt.core.ext.TreeLogger) called immediately after construction.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FACTORY_IMPL_PROPERTY The name of the system property used to define the workers.
static int	WORKERS_AUTO This value can be passed into #setLocalWorkers(int) to indicate that a heuristic should be used to determine the total number of local workers.

Constructor Summary

Constructors

Constructor and Description
PermutationWorkerFactory()

Method Summary

Modifier and Type	Method and Description
static void	compilePermutations(TreeLogger logger, CompilerContext compilerContext, Precompilation precompilation, int localWorkers, List<FileBackedObject<PermutationResult>> resultFiles) Compiles all Permutations in a Precompilation and returns an array of Files that can be consumed by Link using the system-default PermutationWorkersFactories.
static void	compilePermutations(TreeLogger logger, CompilerContext compilerContext, Precompilation precompilation, Permutation[] permutations, int localWorkers, List<FileBackedObject<PermutationResult>> resultFiles) Compiles a subset of the Permutations in a Precompilation and returns an array of Files that can be consumed by Link using the system-default PermutationWorkersFactories.
abstract Collection<com.google.gwt.dev.PermutationWorker>	getWorkers(TreeLogger logger, UnifiedAst unifiedAst, int numWorkers) Return some number of PermutationWorkers.
abstract void	init(TreeLogger logger) Initialize the PermutationWorkerFactory.
abstract boolean	isLocal() Indicates if the PermutationWorkers created by the factory consume computational or memory resources on the local system, as opposed to the per-permutation work being performed on a remote system.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Field Detail

FACTORY_IMPL_PROPERTY

public static final String FACTORY_IMPL_PROPERTY

The name of the system property used to define the workers.

See Also:

Constant Field Values

WORKERS_AUTO

public static final int WORKERS_AUTO

This value can be passed into #setLocalWorkers(int) to indicate that a heuristic should be used to determine the total number of local workers.

See Also:

Constant Field Values

Constructor Detail

PermutationWorkerFactory

public PermutationWorkerFactory()

Method Detail

compilePermutations

public static void compilePermutations(TreeLogger logger,
                                       CompilerContext compilerContext,
                                       Precompilation precompilation,
                                       int localWorkers,
                                       List<FileBackedObject<PermutationResult>> resultFiles)
                                throws UnableToCompleteException

Compiles all Permutations in a Precompilation and returns an array of Files that can be consumed by Link using the system-default PermutationWorkersFactories.

Throws:

UnableToCompleteException

compilePermutations

public static void compilePermutations(TreeLogger logger,
                                       CompilerContext compilerContext,
                                       Precompilation precompilation,
                                       Permutation[] permutations,
                                       int localWorkers,
                                       List<FileBackedObject<PermutationResult>> resultFiles)
                                throws UnableToCompleteException

Compiles a subset of the Permutations in a Precompilation and returns an array of Files that can be consumed by Link using the system-default PermutationWorkersFactories.

Throws:

UnableToCompleteException

getWorkers

public abstract Collection<com.google.gwt.dev.PermutationWorker> getWorkers(TreeLogger logger,
                                                                            UnifiedAst unifiedAst,
                                                                            int numWorkers)
                                                                     throws UnableToCompleteException

Return some number of PermutationWorkers.

Parameters:

unifiedAst - a UnifiedAst

numWorkers - the desired number of workers

Returns:

a collection of PermutationWorkers, the size of which may be less than numWorkers

Throws:

UnableToCompleteException

init

public abstract void init(TreeLogger logger)
                   throws UnableToCompleteException

Initialize the PermutationWorkerFactory.

Throws:

UnableToCompleteException

isLocal

public abstract boolean isLocal()

Indicates if the PermutationWorkers created by the factory consume computational or memory resources on the local system, as opposed to the per-permutation work being performed on a remote system.