com.sleepycat.je.config
Class ConfigParam

java.lang.Object
  extended by com.sleepycat.je.config.ConfigParam
Direct Known Subclasses:
BooleanConfigParam, DurationConfigParam, EnumConfigParam, IntConfigParam, LongConfigParam, RepParams.IdentifierConfigParam, ShortConfigParam

public class ConfigParam
extends Object

A ConfigParam embodies the metadata 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
protected  String name
           
 
Constructor Summary
ConfigParam(String configName, String configDefault, boolean mutable, boolean forReplication)
           
 
Method Summary
 String getDefault()
           
 String getName()
           
 boolean isForReplication()
           
 boolean isMultiValueParam()
           
 boolean isMutable()
           
static String multiValueParamName(String paramName)
           
static String mvParamIndex(String paramName)
           
 void setForReplication(boolean forReplication)
           
 String toString()
           
 void validateValue(String value)
          Validate your value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

name

protected String name
Constructor Detail

ConfigParam

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

multiValueParamName

public static String multiValueParamName(String paramName)

mvParamIndex

public static String mvParamIndex(String paramName)

getName

public String getName()

getDefault

public String getDefault()

isMutable

public boolean isMutable()

isForReplication

public boolean isForReplication()

setForReplication

public void setForReplication(boolean forReplication)

isMultiValueParam

public boolean isMultiValueParam()

validateValue

public void validateValue(String value)
                   throws IllegalArgumentException
Validate your value. (No default validation for strings.) May be overridden for (e.g.) Multi-value params.

Throws:
IllegalArgumentException - via XxxConfig.setXxx methods and XxxConfig(Properties) ctor.

toString

public String toString()
Overrides:
toString in class Object


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