Package org.apache.bookkeeper.common.conf

Class ConfigDef

java.lang.Object

org.apache.bookkeeper.common.conf.ConfigDef

public class ConfigDef
extends Object

A definition of a configuration instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfigDef.Builder	Builder to build a configuration definition.

Method Summary

Modifier and Type	Method	Description
static ConfigDef.Builder	builder()	Create a builder to build a config def.
Set<ConfigKeyGroup>	getGroups()
Map<String,ConfigKey>	getKeys()
Map<String,Set<ConfigKey>>	getSettings()
static ConfigDef	of(Class configClass)	Build the config definitation of a config class.
void	save(OutputStream os)
void	save(Path path)
void	validate(org.apache.commons.configuration2.Configuration conf)	Validate if the provided conf is a valid configuration of this configuration definition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static ConfigDef.Builder builder()

Create a builder to build a config def.

Returns:

builder to build a config def.

validate

public void validate(org.apache.commons.configuration2.Configuration conf)
              throws ConfigException

Validate if the provided conf is a valid configuration of this configuration definition.

Parameters:

conf - the configuration to validate

Throws:

ConfigException

of

public static ConfigDef of(Class configClass)

Build the config definitation of a config class.

Parameters:

configClass - config class

Returns:

config definition.

save

public void save(Path path)
          throws IOException

Throws:

IOException

save

public void save(OutputStream os)
          throws IOException

Throws:

IOException

getGroups

public Set<ConfigKeyGroup> getGroups()

getSettings

public Map<String,Set<ConfigKey>> getSettings()

getKeys

public Map<String,ConfigKey> getKeys()