Package org.apache.bookkeeper.common.conf

Class ConfigKeyGroup

java.lang.Object

org.apache.bookkeeper.common.conf.ConfigKeyGroup

@Public
public class ConfigKeyGroup
extends java.lang.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 ConfigKeyGroup	DEFAULT	The default key group.
static java.util.Comparator<ConfigKeyGroup>	ORDERING	Ordering the key groups in a configuration.

Constructor Summary

Constructors

Constructor	Description
ConfigKeyGroup(java.lang.String name, java.lang.String description, java.util.List<java.lang.String> children, int order)

Method Summary

Modifier and Type	Method	Description
static ConfigKeyGroup.ConfigKeyGroupBuilder	builder(java.lang.String name)	Create a config key group of name.
java.util.List<java.lang.String>	children()	The list of sub key-groups of this key group.
ConfigKeyGroup	children(java.util.List<java.lang.String> children)	The list of sub key-groups of this key group.
java.lang.String	description()	Description of the key group.
ConfigKeyGroup	description(java.lang.String description)	Description of the key group.
boolean	equals(java.lang.Object o)
int	hashCode()
static ConfigKeyGroup.ConfigKeyGroupBuilder	internalBuilder()
java.lang.String	name()	Name of the key group.
ConfigKeyGroup	name(java.lang.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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ORDERING

public static final java.util.Comparator<ConfigKeyGroup> ORDERING

Ordering the key groups in a configuration.

DEFAULT

public static final ConfigKeyGroup DEFAULT

The default key group.

Constructor Detail

ConfigKeyGroup

ConfigKeyGroup(java.lang.String name,
               java.lang.String description,
               java.util.List<java.lang.String> children,
               int order)

Method Detail

builder

public static ConfigKeyGroup.ConfigKeyGroupBuilder builder(java.lang.String name)

Create a config key group of name.

Parameters:

name - key group name

Returns:

key group builder

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

internalBuilder

public static ConfigKeyGroup.ConfigKeyGroupBuilder internalBuilder()

name

public java.lang.String name()

Name of the key group.

description

public java.lang.String description()

Description of the key group.

children

public java.util.List<java.lang.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(java.lang.String name)

Name of the key group.

Returns:

this.

description

public ConfigKeyGroup description(java.lang.String description)

Description of the key group.

Returns:

this.

children

public ConfigKeyGroup children(java.util.List<java.lang.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object