Package com.e1c.langtool.internal.collector

Class FeatureValueCollectingService

java.lang.Object

com.e1c.langtool.internal.collector.FeatureValueCollectingService

All Implemented Interfaces:

IFeatureValueCollectingService

public class FeatureValueCollectingService
extends Object
implements IFeatureValueCollectingService

Constructor Summary

Constructors

Constructor	Description
FeatureValueCollectingService()

Method Summary

Modifier and Type	Method	Description
void	collectAll(org.eclipse.core.resources.IProject project, ICollectingParameters parameters, BiConsumer<Object,FeatureValue> action, ExecutorService executorService, org.eclipse.core.runtime.IProgressMonitor monitor)	Collects feature values and raw source object for the given project and process given action BiConsumer for each of all collected values from project.
void	collectAllByFile(org.eclipse.core.resources.IProject project, ICollectingParameters parameters, BiConsumer<org.eclipse.core.resources.IFile,Collection<FeatureValue>> action, ExecutorService executorService, org.eclipse.core.runtime.IProgressMonitor monitor)	Collect FeatureValue from all files of the project with using or updating resource cache.
void	collectFile(org.eclipse.core.resources.IFile file, ICollectingParameters parameters, BiConsumer<Object,FeatureValue> action, org.eclipse.core.runtime.IProgressMonitor monitor)	Collect all FeatureValue from file.
Set<FeatureValueCollector>	createCollectors(TranslationSource source, ICollectingParameters parameters, BiConsumer<Object,FeatureValue> addAction)	Creates the collectors for the given source object.
Set<FeatureValueCollector>	createCollectors(TranslationSource source, ICollectingParameters parameters, BiConsumer<Object,FeatureValue> addAction, org.eclipse.core.runtime.IProgressMonitor monitor)
void	forEachCollected(TranslationSource source, ICollectingParameters parameters, org.eclipse.core.runtime.IProgressMonitor monitor, BiConsumer<Object,FeatureValue> action)	Collect feature values and raw source object for the given translation source with parameters and process given action BiConsumer for each collected.
boolean	hasCollector(Object source)	Checks if a collector can be created for the given source object.

Methods inherited from class java.lang.Object

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

Constructor Details

FeatureValueCollectingService

public FeatureValueCollectingService()

Method Details

hasCollector

public boolean hasCollector(Object source)

Description copied from interface: IFeatureValueCollectingService

Checks if a collector can be created for the given source object.

Specified by:

hasCollector in interface IFeatureValueCollectingService

Parameters:

source - the source object, if it is a TranslationSource object the check will be for TranslationSource.getSourceObject()

Returns:

true, if collector can be created

createCollectors

public Set<FeatureValueCollector> createCollectors(TranslationSource source,
 ICollectingParameters parameters,
 BiConsumer<Object,FeatureValue> addAction)

Description copied from interface: IFeatureValueCollectingService

Creates the collectors for the given source object. This method should be uses in an implementation of FeatureCollectorFactory to create collectors for sub objects.

Specified by:

createCollectors in interface IFeatureValueCollectingService

Parameters:

source - the source object which has translatable features, cannot be null.

parameters - the parameters, cannot be null.

addAction - the add action, cannot be null.

Returns:

the collection the of newly created collectors, cannot return null.

See Also:

• to collect FeatureValue see collect().
• FeatureCollectorFactory
• FeatureValueCollector

createCollectors

public Set<FeatureValueCollector> createCollectors(TranslationSource source,
 ICollectingParameters parameters,
 BiConsumer<Object,FeatureValue> addAction,
 org.eclipse.core.runtime.IProgressMonitor monitor)

collectAll

public void collectAll(org.eclipse.core.resources.IProject project,
 ICollectingParameters parameters,
 BiConsumer<Object,FeatureValue> action,
 ExecutorService executorService,
 org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IFeatureValueCollectingService

Collects feature values and raw source object for the given project and process given action BiConsumer for each of all collected values from project.

Specified by:

collectAll in interface IFeatureValueCollectingService

Parameters:

project - the project, cannot be null.

parameters - the parameters, cannot be null.

action - the action to do with collected each feature value. The first argument of BiConsumer is the object that provides a FeatureValue and the second argument of the action is the feature value to handle. Warning: the action is responsible to be thread-safe, no guarantee that collecting process and action will be in same thread.

executorService - the executor service, cannot be null.

monitor - the monitor, cannot be null.

collectAllByFile

public void collectAllByFile(org.eclipse.core.resources.IProject project,
 ICollectingParameters parameters,
 BiConsumer<org.eclipse.core.resources.IFile,Collection<FeatureValue>> action,
 ExecutorService executorService,
 org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IFeatureValueCollectingService

Collect FeatureValue from all files of the project with using or updating resource cache. This method return result to consumer all collected values by file at ones.

Specified by:

collectAllByFile in interface IFeatureValueCollectingService

Parameters:

project - the project to collect, cannot be null.

parameters - the parameters, cannot be null.

action - the consumer action to get collection of FeatureValue by the file, cannot be null.

executorService - the executor service, cannot be null.

monitor - the monitor, cannot be null.

collectFile

public void collectFile(org.eclipse.core.resources.IFile file,
 ICollectingParameters parameters,
 BiConsumer<Object,FeatureValue> action,
 org.eclipse.core.runtime.IProgressMonitor monitor)

Description copied from interface: IFeatureValueCollectingService

Collect all FeatureValue from file. This action use cache if exist or update it after collecting.

Specified by:

collectFile in interface IFeatureValueCollectingService

Parameters:

file - the file, cannot be null.

parameters - the parameters, cannot be null.

action - the action, cannot be null.

monitor - the monitor, cannot be null.

forEachCollected

public void forEachCollected(TranslationSource source,
 ICollectingParameters parameters,
 org.eclipse.core.runtime.IProgressMonitor monitor,
 BiConsumer<Object,FeatureValue> action)

Description copied from interface: IFeatureValueCollectingService

Collect feature values and raw source object for the given translation source with parameters and process given action BiConsumer for each collected.

Specified by:

forEachCollected in interface IFeatureValueCollectingService

Parameters:

source - the source, cannot be null.

parameters - the parameters, cannot be null.

monitor - the monitor, cannot be null.

action - the action to do with collected each feature value. The first argument of BiConsumer is the source raw object that provides a FeatureValue and the second argument of the action is the feature value to handle. Warning: the action is responsible to be thread-safe, no guarantee that collecting process and action will be in same thread.