com.groupdocs.search.options

Class DateFormatCollection

java.lang.Object

com.groupdocs.search.options.DateFormatCollection

All Implemented Interfaces:

Iterable<DateFormat>

public abstract class DateFormatCollection
extends Object
implements Iterable<DateFormat>

Represents a collection of DateFormat objects.

Learn more

• Date range search

Constructor Summary

Constructors

Constructor and Description
DateFormatCollection()

Method Summary

Modifier and Type	Method and Description
abstract void	addItem(DateFormat item) Adds an date format object to the collection.
abstract void	clear() Removes all elements from the collection.
abstract boolean	containsItem(DateFormat item) Determines whether the collection contains a specific item.
abstract void	copyToTArray(DateFormat[] 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<DateFormat>	iterator() Returns an enumerator that iterates through the collection.
abstract boolean	removeItem(DateFormat item) Removes the first occurrence of a specific element from the collection.
abstract int	size() Gets the number of elements 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

DateFormatCollection

public DateFormatCollection()

Method Detail

addItem

public abstract void addItem(DateFormat item)

Adds an date format object to the collection.

Parameters:

item - The date format object to add to the collection.

clear

public abstract void clear()

Removes all elements from the collection.

containsItem

public abstract boolean containsItem(DateFormat item)

Determines whether the collection contains a specific item.

Parameters:

item - The item to locate in the collection.

Returns:

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

copyToTArray

public abstract void copyToTArray(DateFormat[] 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 the collection.

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:

true if the collection is read-only; otherwise, false.

iterator

public abstract Iterator<DateFormat> iterator()

Returns an enumerator that iterates through the collection.

Specified by:

iterator in interface Iterable<DateFormat>

Returns:

An enumerator that can be used to iterate through the collection.

removeItem

public abstract boolean removeItem(DateFormat item)

Removes the first occurrence of a specific element from the collection.

Parameters:

item - The item to remove from the collection.

Returns:

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

size

public abstract int size()

Gets the number of elements contained in the collection.

Returns:

The number of elements contained in the collection.