com.groupdocs.search.common

Class CustomExtractorCollection

java.lang.Object

com.groupdocs.search.common.CustomExtractorCollection

All Implemented Interfaces:

Iterable

public abstract class CustomExtractorCollection
extends Object
implements Iterable

Contains a collection of custom extractors. If the collection contains an extractor for some file extension that is covered by build-in extractors, then this extractor will be used instead of built-in one.

Learn more

• Custom text extractors

Constructor Summary

Constructors

Constructor and Description
CustomExtractorCollection()

Method Summary

Modifier and Type	Method and Description
abstract void	addItem(IFieldExtractor extractor) Adds an extractor to the collection.
abstract void	clear() Removes all extractors from the collection.
abstract boolean	containsItem(IFieldExtractor item) Determines whether the collection contains a specific extractor.
abstract void	copyToTArray(IFieldExtractor[] array, int arrayIndex) Copies the elements of the collection to an array, starting at a particular array index.
abstract boolean	isReadOnly() Gets a value indicating whether the collection is read-only.
abstract Iterator<IFieldExtractor>	iterator() Returns an iterator for this collection.
abstract boolean	removeItem(IFieldExtractor extractor) Removes an extractor from the collection.
abstract int	size() Gets the number of extractors contained in the collection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CustomExtractorCollection

public CustomExtractorCollection()

Method Detail

addItem

public abstract void addItem(IFieldExtractor extractor)

Adds an extractor to the collection.

Parameters:

extractor - The extractor to add to the collection.

clear

public abstract void clear()

Removes all extractors from the collection.

containsItem

public abstract boolean containsItem(IFieldExtractor item)

Determines whether the collection contains a specific extractor.

Parameters:

item - The extractor to locate in the collection.

Returns:

true if item is found in the collection; otherwise, false.

copyToTArray

public abstract void copyToTArray(IFieldExtractor[] array,
                                  int arrayIndex)

Copies the elements of the collection to an array, starting at a particular array index.

Parameters:

array - The one-dimensional array that is the destination of the elements copied from collection. The array must have zero-based indexing.

arrayIndex - The zero-based index in array at which copying begins.

isReadOnly

public abstract boolean isReadOnly()

Gets a value indicating whether the collection is read-only.

Returns:

A value indicating whether the collection is read-only.

iterator

public abstract Iterator<IFieldExtractor> iterator()

Returns an iterator for this collection.

Specified by:

iterator in interface Iterable

Returns:

An iterator object that can be used to iterate through the collection.

removeItem

public abstract boolean removeItem(IFieldExtractor extractor)

Removes an extractor from the collection.

Parameters:

extractor - The extractor to remove from the collection.

Returns:

true if extractor was successfully removed from the collection; otherwise, false. This method also returns false if extractor is not found in the original collection.

size

public abstract int size()

Gets the number of extractors contained in the collection.

Returns:

The number of extractors contained in the collection.