com.gigaspaces.client.iterator
Enum IteratorScope

java.lang.Object
  java.lang.Enum<IteratorScope>
      com.gigaspaces.client.iterator.IteratorScope

All Implemented Interfaces:

Serializable, Comparable<IteratorScope>

public enum IteratorScope
extends Enum<IteratorScope>

Determines the scope of a GSIterator.

Since:

7.0

Author:

niv

Enum Constant Summary

CURRENT
Indicates that the iterator will process entries currently in the space, and ignores future changes.

CURRENT_AND_FUTURE
Indicates that the iterator will process both entries currently in the space and future changes.

FUTURE
Indicates that the iterator will ignore entries currently in the space, and process future changes.

Method Summary

boolean	hasCurrent()
boolean	hasFuture()
static IteratorScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static IteratorScope[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CURRENT

public static final IteratorScope CURRENT

Indicates that the iterator will process entries currently in the space, and ignores future changes.

FUTURE

public static final IteratorScope FUTURE

Indicates that the iterator will ignore entries currently in the space, and process future changes.

CURRENT_AND_FUTURE

public static final IteratorScope CURRENT_AND_FUTURE

Indicates that the iterator will process both entries currently in the space and future changes.

Method Detail

values

public static final IteratorScope[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(IteratorScope c : IteratorScope.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static IteratorScope valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

hasCurrent

public boolean hasCurrent()

Returns:

true if the value is CURRENT or CURRENT_AND_FUTURE, false otherwise.

hasFuture

public boolean hasFuture()

Returns:

true if the value is FUTURE or CURRENT_AND_FUTURE, false otherwise.