Package org.apache.bookkeeper.common.conf

Class ConfigKeyGroup

java.lang.Object

org.apache.bookkeeper.common.conf.ConfigKeyGroup

@Public
public class ConfigKeyGroup
extends Object

Define a group of configuration settings.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConfigKeyGroup.ConfigKeyGroupBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final ConfigKeyGroup	DEFAULT	The default key group.
static final Comparator<ConfigKeyGroup>	ORDERING	Ordering the key groups in a configuration.

Constructor Summary

Constructors

Constructor	Description
ConfigKeyGroup(String name, String description, List<String> children, int order)	Creates a new ConfigKeyGroup instance.

Method Summary

Modifier and Type	Method	Description
static ConfigKeyGroup.ConfigKeyGroupBuilder	builder(String name)	Create a config key group of name.
List<String>	children()	The list of sub key-groups of this key group.
ConfigKeyGroup	children(List<String> children)	The list of sub key-groups of this key group.
String	description()	Description of the key group.
ConfigKeyGroup	description(String description)	Description of the key group.
boolean	equals(Object o)
int	hashCode()
static ConfigKeyGroup.ConfigKeyGroupBuilder	internalBuilder()
String	name()	Name of the key group.
ConfigKeyGroup	name(String name)	Name of the key group.
int	order()	The order of the key-group in a configuration.
ConfigKeyGroup	order(int order)	The order of the key-group in a configuration.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ORDERING

public static final Comparator<ConfigKeyGroup> ORDERING

Ordering the key groups in a configuration.

DEFAULT

public static final ConfigKeyGroup DEFAULT

The default key group.

Constructor Details

ConfigKeyGroup

ConfigKeyGroup(String name,
 String description,
 List<String> children,
 int order)

Creates a new ConfigKeyGroup instance.

Parameters:

name - Name of the key group.

description - Description of the key group.

children - The list of sub key-groups of this key group.

order - The order of the key-group in a configuration.

Method Details

builder

public static ConfigKeyGroup.ConfigKeyGroupBuilder builder(String name)

Create a config key group of name.

Parameters:

name - key group name

Returns:

key group builder

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

internalBuilder

public static ConfigKeyGroup.ConfigKeyGroupBuilder internalBuilder()

name

public String name()

Name of the key group.

description

public String description()

Description of the key group.

children

public List<String> children()

The list of sub key-groups of this key group.

order

public int order()

The order of the key-group in a configuration.

name

public ConfigKeyGroup name(String name)

Name of the key group.

Returns:

this.

description

public ConfigKeyGroup description(String description)

Description of the key group.

Returns:

this.

children

public ConfigKeyGroup children(List<String> children)

The list of sub key-groups of this key group.

Returns:

this.

order

public ConfigKeyGroup order(int order)

The order of the key-group in a configuration.

Returns:

this.

toString

public String toString()

Overrides:

toString in class Object