backtype.storm

Class ConfigValidation

java.lang.Object

backtype.storm.ConfigValidation

public class ConfigValidation
extends Object

Provides functionality for validating configuration fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConfigValidation.FieldValidator Declares methods for validating configuration values.
static class	ConfigValidation.NestableFieldValidator Declares a method for validating configuration values that is nestable.

Field Summary

Fields

Modifier and Type	Field and Description
static Object	DoubleValidator Validates a Double.
static Object	IntegersValidator Validates is a list of Integers.
static Object	IntegerValidator Validates a Integer.
static Object	KryoRegValidator Validates Kryo Registration
static Object	MapOfStringToMapValidator Validates a map of Strings to a map of Strings to a list.
static Object	MapOfStringToNumberValidator Validates a map of Strings to Numbers.
static Object	MapsValidator Validates is a list of Maps.
static Object	NotNullPosIntegerValidator Validates a non null Integer > 0
static Object	NumbersValidator Validates a list of Numbers.
static Object	PositiveIntegerValidator Validates a positive integer.
static Object	PowerOf2Validator Validates a power of 2.
static Object	StringOrStringListValidator Validates a String or a list of Strings
static Object	StringsValidator Validates a list of Strings.

Constructor Summary

Constructors

Constructor and Description
ConfigValidation()

Method Summary

Methods

Modifier and Type	Method and Description
static ConfigValidation.NestableFieldValidator	fv(Class cls, boolean nullAllowed) Returns a new NestableFieldValidator for a given class.
static ConfigValidation.NestableFieldValidator	listFv(Class cls, boolean nullAllowed) Returns a new NestableFieldValidator for a List of the given Class.
static ConfigValidation.NestableFieldValidator	listFv(ConfigValidation.NestableFieldValidator validator, boolean nullAllowed) Returns a new NestableFieldValidator for a List where each item is validated by validator.
static ConfigValidation.NestableFieldValidator	mapFv(Class key, Class val, boolean nullAllowed) Returns a new NestableFieldValidator for a Map of key to val.
static ConfigValidation.NestableFieldValidator	mapFv(ConfigValidation.NestableFieldValidator key, ConfigValidation.NestableFieldValidator val, boolean nullAllowed) Returns a new NestableFieldValidator for a Map.

Methods inherited from class java.lang.Object

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

Field Detail

NumbersValidator

public static Object NumbersValidator

Validates a list of Numbers.

StringsValidator

public static Object StringsValidator

Validates a list of Strings.

MapOfStringToNumberValidator

public static Object MapOfStringToNumberValidator

Validates a map of Strings to Numbers.

MapOfStringToMapValidator

public static Object MapOfStringToMapValidator

Validates a map of Strings to a map of Strings to a list. {str -> {str -> [str,str]}

MapsValidator

public static Object MapsValidator

Validates is a list of Maps.

NotNullPosIntegerValidator

public static Object NotNullPosIntegerValidator

Validates a non null Integer > 0

IntegerValidator

public static Object IntegerValidator

Validates a Integer.

IntegersValidator

public static Object IntegersValidator

Validates is a list of Integers.

DoubleValidator

public static Object DoubleValidator

Validates a Double.

PowerOf2Validator

public static Object PowerOf2Validator

Validates a power of 2.

PositiveIntegerValidator

public static Object PositiveIntegerValidator

Validates a positive integer.

KryoRegValidator

public static Object KryoRegValidator

Validates Kryo Registration

StringOrStringListValidator

public static Object StringOrStringListValidator

Validates a String or a list of Strings

Constructor Detail

ConfigValidation

public ConfigValidation()

Method Detail

fv

public static ConfigValidation.NestableFieldValidator fv(Class cls,
                                         boolean nullAllowed)

Returns a new NestableFieldValidator for a given class.

Parameters:

cls - the Class the field should be a type of

nullAllowed - whether or not a value of null is valid

Returns:

a NestableFieldValidator for that class

listFv

public static ConfigValidation.NestableFieldValidator listFv(Class cls,
                                             boolean nullAllowed)

Returns a new NestableFieldValidator for a List of the given Class.

Parameters:

cls - the Class of elements composing the list

nullAllowed - whether or not a value of null is valid

Returns:

a NestableFieldValidator for a list of the given class

listFv

public static ConfigValidation.NestableFieldValidator listFv(ConfigValidation.NestableFieldValidator validator,
                                             boolean nullAllowed)

Returns a new NestableFieldValidator for a List where each item is validated by validator.

Parameters:

validator - used to validate each item in the list

nullAllowed - whether or not a value of null is valid

Returns:

a NestableFieldValidator for a list with each item validated by a different validator.

mapFv

public static ConfigValidation.NestableFieldValidator mapFv(Class key,
                                            Class val,
                                            boolean nullAllowed)

Returns a new NestableFieldValidator for a Map of key to val.

Parameters:

key - the Class of keys in the map

val - the Class of values in the map

nullAllowed - whether or not a value of null is valid

Returns:

a NestableFieldValidator for a Map of key to val

mapFv

public static ConfigValidation.NestableFieldValidator mapFv(ConfigValidation.NestableFieldValidator key,
                                            ConfigValidation.NestableFieldValidator val,
                                            boolean nullAllowed)

Returns a new NestableFieldValidator for a Map.

Parameters:

key - a validator for the keys in the map

val - a validator for the values in the map

nullAllowed - whether or not a value of null is valid

Returns:

a NestableFieldValidator for a Map