net.citrusleaf
Class CitrusleafClient.ClScanningOptions

java.lang.Object
  extended by net.citrusleaf.CitrusleafClient.ClScanningOptions
Enclosing class:
CitrusleafClient

public static class CitrusleafClient.ClScanningOptions
extends java.lang.Object

Container object for optional parameters used in scan operations.

This object is passed in scan...() calls to specify options. null may be passed to use defaults for all options.


Constructor Summary
CitrusleafClient.ClScanningOptions()
          Constructor, sets default scan options.
 
Method Summary
 CitrusleafClient.ClScanningPriority getPriority()
          Get server scan priority setting.
 int getThreadsPerNode()
          Get number of client scan threads per node.
 boolean isConcurrentNodes()
          Get concurrent nodes scan setting.
 boolean isFailOnClusterChange()
          Get scan termination setting.
 void setConcurrentNodes(boolean concurrentNodes)
          Specify concurrent nodes scan setting.
 void setFailOnClusterChange(boolean failOnClusterChange)
          Specify scan termination setting.
 void setPriority(CitrusleafClient.ClScanningPriority priority)
          Specify server scan priority setting.
 void setThreadsPerNode(int threadsPerNode)
          Specify number of client scan threads per node - not yet supported.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CitrusleafClient.ClScanningOptions

public CitrusleafClient.ClScanningOptions()
Constructor, sets default scan options.

The object is constructed with concurrent nodes scan enabled, one thread per node, scan priority CitrusleafClient.ClScanningPriority.AUTO, and scan termination on cluster changes disabled.

Method Detail

isConcurrentNodes

public boolean isConcurrentNodes()
Get concurrent nodes scan setting.

Returns:
true if concurrent nodes scan is enabled, false if not

setConcurrentNodes

public void setConcurrentNodes(boolean concurrentNodes)
Specify concurrent nodes scan setting.

Parameters:
concurrentNodes - true to enable concurrent nodes scan, false to disable

getThreadsPerNode

public int getThreadsPerNode()
Get number of client scan threads per node.

Returns:
number of client threads used to scan a node

setThreadsPerNode

public void setThreadsPerNode(int threadsPerNode)
Specify number of client scan threads per node - not yet supported.

Parameters:
threadsPerNode - number of client threads used to scan a node

getPriority

public CitrusleafClient.ClScanningPriority getPriority()
Get server scan priority setting.

Returns:
scan priority to be used by server

setPriority

public void setPriority(CitrusleafClient.ClScanningPriority priority)
Specify server scan priority setting.

Parameters:
priority - scan priority to be used by server

isFailOnClusterChange

public boolean isFailOnClusterChange()
Get scan termination setting.

Returns:
true if scan will terminate on cluster change, false if not

setFailOnClusterChange

public void setFailOnClusterChange(boolean failOnClusterChange)
Specify scan termination setting.

Parameters:
failOnClusterChange - true to terminate scan on cluster change, false to continue scan