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 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 String CONFIG_DELIM
           
protected  String name
           
 
Constructor Summary
ConfigParam(String configName, String configDefault, boolean mutable, boolean forReplication, String description)
           
 
Method Summary
 String getDefault()
           
 String getDescription()
           
 String getExtraDescription()
           
 String getName()
           
 boolean isForReplication()
           
 boolean isMutable()
           
 void setForReplication(boolean forReplication)
           
 String toString()
           
 void validate()
          Validate yourself.
 void validateValue(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 String CONFIG_DELIM
See Also:
Constant Field Values

name

protected String name
Constructor Detail

ConfigParam

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

getName

public String getName()

getDescription

public String getDescription()

getExtraDescription

public String getExtraDescription()

getDefault

public String getDefault()

isMutable

public boolean isMutable()

isForReplication

public boolean isForReplication()

setForReplication

public void setForReplication(boolean forReplication)

validate

public void validate()
              throws IllegalArgumentException
Validate yourself.

Throws:
IllegalArgumentException

validateValue

public void validateValue(String value)
                   throws IllegalArgumentException
Throws:
IllegalArgumentException

toString

public String toString()
Overrides:
toString in class Object


Copyright 2004,2008 Oracle. All rights reserved.