org.apache.kafka.common.config

Class ConfigDef.Range

java.lang.Object

org.apache.kafka.common.config.ConfigDef.Range

All Implemented Interfaces:

ConfigDef.Validator

Enclosing class:

ConfigDef

public static class ConfigDef.Range
extends Object
implements ConfigDef.Validator

Validation logic for numeric ranges

Method Summary

Modifier and Type	Method and Description
static ConfigDef.Range	atLeast(Number min) A numeric range that checks only the lower bound
static ConfigDef.Range	atMost(Number max) A numeric range that checks only the upper (inclusive) bound
static ConfigDef.Range	between(Number min, Number max) A numeric range that checks both the upper (inclusive) and lower bound
void	ensureValid(String name, Object o) Perform single configuration validation.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

atLeast

public static ConfigDef.Range atLeast(Number min)

A numeric range that checks only the lower bound

Parameters:

min - The minimum acceptable value

atMost

public static ConfigDef.Range atMost(Number max)

A numeric range that checks only the upper (inclusive) bound

Parameters:

max - The minimum acceptable value

between

public static ConfigDef.Range between(Number min,
                                      Number max)

A numeric range that checks both the upper (inclusive) and lower bound

ensureValid

public void ensureValid(String name,
                        Object o)

Description copied from interface: ConfigDef.Validator

Perform single configuration validation.

Specified by:

ensureValid in interface ConfigDef.Validator

Parameters:

name - The name of the configuration

o - The value of the configuration

toString

public String toString()

Overrides:

toString in class Object