org.apache.brooklyn.core.config

Class ConfigConstraints<T extends BrooklynObject>

java.lang.Object

org.apache.brooklyn.core.config.ConfigConstraints<T>

public abstract class ConfigConstraints<T extends BrooklynObject>
extends java.lang.Object

Checks configuration constraints on entities and their adjuncts.

Since:

0.9.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigConstraints.RequiredPredicate<T> Predicate indicating a field is required: it must not be null and if a string it must not be empty

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
ConfigConstraints(T brooklynObject)

Method Summary

Modifier and Type	Method and Description
static void	assertValid(Entity entity) Checks all constraints of all config keys available to an entity.
static void	assertValid(EntityAdjunct adjunct) Checks all constraints of all config keys available to an entity adjunct.
static <T> void	assertValid(Entity entity, ConfigKey<T> key, T value)
static <T> void	assertValid(Location location, ConfigKey<T> key, T value)
static <any>	forbiddenIf(java.lang.String otherKeyName)
static <any>	forbiddenUnless(java.lang.String otherKeyName)
static <any>	forbiddenUnlessAnyOf(java.util.List<java.lang.String> otherKeyNames)
java.lang.Iterable<ConfigKey<?>>	getViolations()
static <T> <any>	required()
static <any>	requiredIf(java.lang.String otherKeyName)
static <any>	requiredUnless(java.lang.String otherKeyName)
static <any>	requiredUnlessAnyOf(java.util.List<java.lang.String> otherKeyNames)
static ConstraintSerialization	serialization() Convenience method to get the serialization routines.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

Constructor Detail

ConfigConstraints

public ConfigConstraints(T brooklynObject)

Method Detail

assertValid

public static void assertValid(Entity entity)

Checks all constraints of all config keys available to an entity.

If a constraint is a BrooklynObjectPredicate then BrooklynObjectPredicate.apply(Object, BrooklynObject) will be used.

assertValid

public static void assertValid(EntityAdjunct adjunct)

Checks all constraints of all config keys available to an entity adjunct.

If a constraint is a BrooklynObjectPredicate then BrooklynObjectPredicate.apply(Object, BrooklynObject) will be used.

assertValid

public static <T> void assertValid(Entity entity,
                                   ConfigKey<T> key,
                                   T value)

assertValid

public static <T> void assertValid(Location location,
                                   ConfigKey<T> key,
                                   T value)

getViolations

public java.lang.Iterable<ConfigKey<?>> getViolations()

serialization

public static ConstraintSerialization serialization()

Convenience method to get the serialization routines.

required

public static <T> <any> required()

forbiddenIf

public static <any> forbiddenIf(java.lang.String otherKeyName)

forbiddenUnless

public static <any> forbiddenUnless(java.lang.String otherKeyName)

requiredIf

public static <any> requiredIf(java.lang.String otherKeyName)

requiredUnless

public static <any> requiredUnless(java.lang.String otherKeyName)

forbiddenUnlessAnyOf

public static <any> forbiddenUnlessAnyOf(java.util.List<java.lang.String> otherKeyNames)

requiredUnlessAnyOf

public static <any> requiredUnlessAnyOf(java.util.List<java.lang.String> otherKeyNames)