com.atlassian.clover.optimization

Class LocalSnapshotOptimizer

java.lang.Object

com.atlassian.clover.optimization.LocalSnapshotOptimizer

All Implemented Interfaces:

Optimizer

public final class LocalSnapshotOptimizer
extends Object
implements Optimizer

An Optimizer that uses a local Snapshot file to optimize.

Constructor Summary

Constructors

Constructor and Description
LocalSnapshotOptimizer(OptimizationOptions options)
LocalSnapshotOptimizer(Snapshot snapshot, Clover2Registry registry, OptimizationOptions options)

Method Summary

Modifier and Type	Method and Description
String	cannotOptimizeCause()
boolean	canOptimize() Determines if the Optimizer is in a state where it can optimize.
<E extends Optimizable> boolean	include(E optimizable, OptimizationSession session) Determines if an Optimizable object should be included in optimized output or not - used by clients where the full list of Optimizable objects to be optimized can not be calculated up-front.
boolean	isTooStale()
<E extends Optimizable> List<E>	optimize(Collection<E> optimizables) Optimizes a Collection of Optimizable objects.
<E extends Optimizable> List<E>	optimize(Collection<E> mandatoryOptimizables, Collection<E> optionalOptimizables) Optimizes two Collections of Optimizable objects where the first Collection must not be minimzed.
static <E extends Optimizable> List<E>	optimize(Collection<E> mandatoryOptimizables, Collection<E> optionalOptimizables, OptimizationOptions options) Static convenience method to optimize
<E extends Optimizable> List<E>	optimize(Collection<E> mandatoryOptimizables, Collection<E> optionalOptimizables, OptimizationSession session) Optimizes two Collections of Optimizable objects where the first Collection must not be minimzed.
static <E extends Optimizable> List<E>	optimize(Collection<E> optimizables, OptimizationOptions options) Static convenience method to optimize
<E extends Optimizable> List<E>	optimize(Collection<E> optimizables, OptimizationSession session) Optimizes a Collection of Optimizable objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalSnapshotOptimizer

public LocalSnapshotOptimizer(Snapshot snapshot,
                              Clover2Registry registry,
                              OptimizationOptions options)

LocalSnapshotOptimizer

public LocalSnapshotOptimizer(OptimizationOptions options)

Parameters:

options - non-null OptimizationOptions for optimization

Method Detail

optimize

public static <E extends Optimizable> List<E> optimize(Collection<E> optimizables,
                                                       OptimizationOptions options)
                                                throws CloverException

Static convenience method to optimize

Throws:

CloverException

optimize

public static <E extends Optimizable> List<E> optimize(Collection<E> mandatoryOptimizables,
                                                       Collection<E> optionalOptimizables,
                                                       OptimizationOptions options)
                                                throws CloverException

Static convenience method to optimize

Throws:

CloverException

include

public <E extends Optimizable> boolean include(E optimizable,
                                               OptimizationSession session)

Description copied from interface: Optimizer

Determines if an Optimizable object should be included in optimized output or not - used by clients where the full list of Optimizable objects to be optimized can not be calculated up-front.

Specified by:

include in interface Optimizer

Parameters:

optimizable - the subject of the query

session - stores incremental information about optimization and can be later used for debug/logging summary

optimize

public <E extends Optimizable> List<E> optimize(Collection<E> optimizables)

Description copied from interface: Optimizer

Optimizes a Collection of Optimizable objects.

Specified by:

optimize in interface Optimizer

optimize

public <E extends Optimizable> List<E> optimize(Collection<E> optimizables,
                                                OptimizationSession session)

Description copied from interface: Optimizer

Optimizes a Collection of Optimizable objects.

Specified by:

optimize in interface Optimizer

optimize

public <E extends Optimizable> List<E> optimize(Collection<E> mandatoryOptimizables,
                                                Collection<E> optionalOptimizables)

Description copied from interface: Optimizer

Optimizes two Collections of Optimizable objects where the first Collection must not be minimzed.

Specified by:

optimize in interface Optimizer

optimize

public <E extends Optimizable> List<E> optimize(Collection<E> mandatoryOptimizables,
                                                Collection<E> optionalOptimizables,
                                                OptimizationSession session)

Description copied from interface: Optimizer

Optimizes two Collections of Optimizable objects where the first Collection must not be minimzed.

Specified by:

optimize in interface Optimizer

canOptimize

public boolean canOptimize()

Description copied from interface: Optimizer

Determines if the Optimizer is in a state where it can optimize. If it is not able to optimize, Optimizer.include(Optimizable, OptimizationSession) will return true and both Optimizer.optimize(java.util.Collection) and Optimizer.optimize(java.util.Collection, java.util.Collection) will return all supplied Optimizable objects supplied to it.

Specified by:

canOptimize in interface Optimizer

isTooStale

public boolean isTooStale()

cannotOptimizeCause

public String cannotOptimizeCause()