Berkeley DB Java Edition
version 5.0.34

com.sleepycat.je
Class VerifyConfig

java.lang.Object
  extended by com.sleepycat.je.VerifyConfig
All Implemented Interfaces:
Cloneable

public class VerifyConfig
extends Object
implements Cloneable

Specifies the attributes of a verification operation.


Field Summary
static VerifyConfig DEFAULT
           
 
Constructor Summary
VerifyConfig()
          An instance created using the default constructor is initialized with the system's default settings.
 
Method Summary
 VerifyConfig clone()
          Returns a copy of this configuration object.
 boolean getAggressive()
          Returns true if the Environment.verify and Database.verify are configured to perform fine granularity consistency checking that includes verifying in memory constructs.
 boolean getPrintInfo()
          Returns true if the Environment.verify and Database.verify are configured to print basic verification information to System.out.
 boolean getPropagateExceptions()
          Returns true if the Environment.verify and Database.verify are configured to propagate exceptions found during verification.
 int getShowProgressInterval()
          Returns the showProgressInterval value, if set.
 PrintStream getShowProgressStream()
          Returns the PrintStream on which the progress messages will be displayed during long running verify operations.
 VerifyConfig setAggressive(boolean aggressive)
          Configures Environment.verify and Database.verify to perform fine granularity consistency checking that includes verifying in memory constructs.
 VerifyConfig setPrintInfo(boolean printInfo)
          Configures Environment.verify and Database.verify to print basic verification information to System.out.
 VerifyConfig setPropagateExceptions(boolean propagate)
          Configures Environment.verify and Database.verify to propagate exceptions found during verification.
 VerifyConfig setShowProgressInterval(int showProgressInterval)
          When the verify operation is configured to display progress the showProgressInterval is the number of LNs between each progress report.
 VerifyConfig setShowProgressStream(PrintStream showProgressStream)
          Configures the verify operation to display progress to the PrintStream argument.
 String toString()
          Returns the values for each configuration attribute.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT

public static final VerifyConfig DEFAULT
Constructor Detail

VerifyConfig

public VerifyConfig()
An instance created using the default constructor is initialized with the system's default settings.

Method Detail

setPropagateExceptions

public VerifyConfig setPropagateExceptions(boolean propagate)
Configures Environment.verify and Database.verify to propagate exceptions found during verification.

By default this is false and exception information is printed to System.out for notification but does not stop the verification activity, which continues on for as long as possible.

Parameters:
propagate - If set to true, configure Environment.verify and Database.verify to propagate exceptions found during verification.
Returns:
this

getPropagateExceptions

public boolean getPropagateExceptions()
Returns true if the Environment.verify and Database.verify are configured to propagate exceptions found during verification.

This method may be called at any time during the life of the application.

Returns:
true if the Environment.verify and Database.verify are configured to propagate exceptions found during verification.

setAggressive

public VerifyConfig setAggressive(boolean aggressive)
Configures Environment.verify and Database.verify to perform fine granularity consistency checking that includes verifying in memory constructs.

This level of checking should only be performed while the database environment is quiescent.

By default this is false.

Parameters:
aggressive - If set to true, configure Environment.verify and Database.verify to perform fine granularity consistency checking that includes verifying in memory constructs.
Returns:
this

getAggressive

public boolean getAggressive()
Returns true if the Environment.verify and Database.verify are configured to perform fine granularity consistency checking that includes verifying in memory constructs.

This method may be called at any time during the life of the application.

Returns:
true if the Environment.verify and Database.verify are configured to perform fine granularity consistency checking that includes verifying in memory constructs.

setPrintInfo

public VerifyConfig setPrintInfo(boolean printInfo)
Configures Environment.verify and Database.verify to print basic verification information to System.out.

By default this is false.

Parameters:
printInfo - If set to true, configure Environment.verify and Database.verify to print basic verification information to System.out.
Returns:
this

getPrintInfo

public boolean getPrintInfo()
Returns true if the Environment.verify and Database.verify are configured to print basic verification information to System.out.

This method may be called at any time during the life of the application.

Returns:
true if the Environment.verify and Database.verify are configured to print basic verification information to System.out.

setShowProgressStream

public VerifyConfig setShowProgressStream(PrintStream showProgressStream)
Configures the verify operation to display progress to the PrintStream argument. The accumulated statistics will be displayed every N records, where N is the value of showProgressInterval.

Returns:
this

getShowProgressStream

public PrintStream getShowProgressStream()
Returns the PrintStream on which the progress messages will be displayed during long running verify operations.


setShowProgressInterval

public VerifyConfig setShowProgressInterval(int showProgressInterval)
When the verify operation is configured to display progress the showProgressInterval is the number of LNs between each progress report.

Returns:
this

getShowProgressInterval

public int getShowProgressInterval()
Returns the showProgressInterval value, if set.


clone

public VerifyConfig clone()
Returns a copy of this configuration object.

Overrides:
clone in class Object

toString

public String toString()
Returns the values for each configuration attribute.

Overrides:
toString in class Object
Returns:
the values for each configuration attribute.

Berkeley DB Java Edition
version 5.0.34

Copyright (c) 2004-2011 Oracle. All rights reserved.