com.sleepycat.je

Class ReadOptions

java.lang.Object

com.sleepycat.je.ReadOptions

All Implemented Interfaces:

java.lang.Cloneable

public class ReadOptions
extends java.lang.Object
implements java.lang.Cloneable

Options for calling methods that read records.

Since:

7.0

Constructor Summary

Constructors

Constructor and Description
ReadOptions() Constructs a ReadOptions object with default values for all properties.

Method Summary

Modifier and Type	Method and Description
ReadOptions	clone()
CacheMode	getCacheMode() Returns the CacheMode to be used for the operation, or null if the Cursor, Database or Environment default will be used.
LockMode	getLockMode() Returns the LockMode to be used for the operation.
ReadOptions	setCacheMode(CacheMode cacheMode) Sets the CacheMode to be used for the operation.
ReadOptions	setLockMode(LockMode lockMode) Sets the LockMode to be used for the operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadOptions

public ReadOptions()

Constructs a ReadOptions object with default values for all properties.

Method Detail

clone

public ReadOptions clone()

Overrides:

clone in class java.lang.Object

setCacheMode

public ReadOptions setCacheMode(CacheMode cacheMode)

Sets the CacheMode to be used for the operation.

By default this property is null, meaning that the default specified using Cursor.setCacheMode(com.sleepycat.je.CacheMode), DatabaseConfig.setCacheMode(com.sleepycat.je.CacheMode) or EnvironmentMutableConfig.setCacheMode(com.sleepycat.je.CacheMode) will be used.

Parameters:

cacheMode - is the CacheMode used for the operation, or null to use the Cursor, Database or Environment default.

Returns:

'this'.

getCacheMode

public CacheMode getCacheMode()

Returns the CacheMode to be used for the operation, or null if the Cursor, Database or Environment default will be used.

See Also:

setCacheMode(CacheMode)

setLockMode

public ReadOptions setLockMode(LockMode lockMode)

Sets the LockMode to be used for the operation.

By default this property is LockMode.DEFAULT.

Parameters:

lockMode - the locking attributes. Specifying null or LockMode.READ_COMMITTED is not allowed.

Returns:

'this'.

getLockMode

public LockMode getLockMode()

Returns the LockMode to be used for the operation.

See Also:

setLockMode(LockMode)