com.sleepycat.je.config
Class ConfigParam

java.lang.Object
  extended by com.sleepycat.je.config.ConfigParam
Direct Known Subclasses:
BooleanConfigParam, IntConfigParam, LongConfigParam

public class ConfigParam
extends java.lang.Object

A ConfigParam embodies the metatdata about a JE configuration parameter: the parameter name, default value, and a validation method. Validation can be done in the scope of this parameter, or as a function of other parameters.


Field Summary
static java.lang.String CONFIG_DELIM
           
protected  java.lang.String name
           
 
Constructor Summary
ConfigParam(java.lang.String configName, java.lang.String configDefault, boolean mutable, boolean forReplication, java.lang.String description)
           
 
Method Summary
 java.lang.String getDefault()
           
 java.lang.String getDescription()
           
 java.lang.String getExtraDescription()
           
 java.lang.String getName()
           
 boolean isForReplication()
           
 boolean isMutable()
           
 void setForReplication(boolean forReplication)
           
 java.lang.String toString()
           
 void validate()
          Validate yourself.
 void validateValue(java.lang.String value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CONFIG_DELIM

public static final java.lang.String CONFIG_DELIM
See Also:
Constant Field Values

name

protected java.lang.String name
Constructor Detail

ConfigParam

public ConfigParam(java.lang.String configName,
                   java.lang.String configDefault,
                   boolean mutable,
                   boolean forReplication,
                   java.lang.String description)
            throws java.lang.IllegalArgumentException
Throws:
java.lang.IllegalArgumentException
Method Detail

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getExtraDescription

public java.lang.String getExtraDescription()

getDefault

public java.lang.String getDefault()

isMutable

public boolean isMutable()

isForReplication

public boolean isForReplication()

setForReplication

public void setForReplication(boolean forReplication)

validate

public void validate()
              throws java.lang.IllegalArgumentException
Validate yourself.

Throws:
java.lang.IllegalArgumentException

validateValue

public void validateValue(java.lang.String value)
                   throws java.lang.IllegalArgumentException
Throws:
java.lang.IllegalArgumentException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright 2004,2008 Oracle. All rights reserved.