com.atlassian.clover.optimization

Interface Optimizer

All Known Implementing Classes:

LocalSnapshotOptimizer

public interface Optimizer

Interface for implementations that can optimize a collection of Optimizable objects. Optimization is defined as one or both of:

• Eliminating an object from the supplied lists (by not returning it) - called minimization;
• Reordering the list of objects supplied in some beneficial way.

Method Summary

Modifier and Type	Method and Description
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.
<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.
<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.
<E extends Optimizable> List<E>	optimize(Collection<E> optimizables, OptimizationSession session) Optimizes a Collection of Optimizable objects.

Method Detail

optimize

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

Optimizes a Collection of Optimizable objects.

optimize

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

Optimizes a Collection of Optimizable objects.

optimize

<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.

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.

include

<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.

Parameters:

optimizable - the subject of the query

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

canOptimize

boolean canOptimize()

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