com.gigaspaces.client.iterator
Class GSIteratorConfig

java.lang.Object
  com.gigaspaces.client.iterator.GSIteratorConfig

public class GSIteratorConfig
extends Object

Configuration class for GSIterator.

Since:

7.0

Author:

niv

See Also:

GSIterator

Constructor Summary

GSIteratorConfig()
Default constructor.

GSIteratorConfig(int bufferSize, IteratorScope iteratorScope)
Constructor for direct initialization of setBufferSize(int) and setIteratorScope(IteratorScope).

Method Summary

int	getBufferSize() Gets the iterator's buffer size.
EventSessionConfig	getEventSessionConfig() Gets the iterator's event session configuration.
IteratorScope	getIteratorScope() Gets the iterator's iteration scope.
long	getLeaseDuration() Gets the iterator's lease duration.
int	getReadModifiers() Gets the read modifiers the iterator will use to read entries.
GSIteratorConfig	setBufferSize(int value) Sets the iterator's buffer size
GSIteratorConfig	setEventSessionConfig(EventSessionConfig value) Sets the iterator's event session configuration.
GSIteratorConfig	setIteratorScope(IteratorScope value) Sets the iterator's iteration scope.
GSIteratorConfig	setLeaseDuration(long value) Sets the iterator's lease duration.
GSIteratorConfig	setReadModifiers(int readModifiers) Sets the read modifiers the iterator will use to read entries.

Methods inherited from class java.lang.Object

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

Constructor Detail

GSIteratorConfig

public GSIteratorConfig()

Default constructor.

GSIteratorConfig

public GSIteratorConfig(int bufferSize,
                        IteratorScope iteratorScope)

Constructor for direct initialization of setBufferSize(int) and setIteratorScope(IteratorScope).

Parameters:

bufferSize -

iteratorScope -

Method Detail

getBufferSize

public int getBufferSize()

Gets the iterator's buffer size.

Returns:

Currently configured buffer size.

setBufferSize

public GSIteratorConfig setBufferSize(int value)

Sets the iterator's buffer size

Parameters:

value - Buffer size.

getIteratorScope

public IteratorScope getIteratorScope()

Gets the iterator's iteration scope.

Returns:

Currently configured iteration scope.

setIteratorScope

public GSIteratorConfig setIteratorScope(IteratorScope value)

Sets the iterator's iteration scope.

Parameters:

value - Iteration scope.

getLeaseDuration

public long getLeaseDuration()

Gets the iterator's lease duration.

Returns:

Currently configured lease duration.

setLeaseDuration

public GSIteratorConfig setLeaseDuration(long value)

Sets the iterator's lease duration.

Parameters:

value - lease duration in milliseconds.

getEventSessionConfig

public EventSessionConfig getEventSessionConfig()

Gets the iterator's event session configuration.

Returns:

Current event session configuration.

setEventSessionConfig

public GSIteratorConfig setEventSessionConfig(EventSessionConfig value)

Sets the iterator's event session configuration.

Parameters:

value - Event session configuration.

getReadModifiers

public int getReadModifiers()

Gets the read modifiers the iterator will use to read entries.

Since:

8.0.3

setReadModifiers

public GSIteratorConfig setReadModifiers(int readModifiers)

Sets the read modifiers the iterator will use to read entries.

Since:

8.0.3