A C D E F G I M N S T V

A

Assert - Class in net.sf.staccatocommons.check

Assert is a utility class for performing postcondition checks

C

Check<ExceptionType extends Throwable> - Class in net.sf.staccatocommons.check

Checks are objects that validate conditions.

Check() - Constructor for class net.sf.staccatocommons.check.Check

Check.Failure - Class in net.sf.staccatocommons.check

A basic check failure

Check.Failure(String) - Constructor for class net.sf.staccatocommons.check.Check.Failure

Creates a new Check.Failure

Check.VarFailure - Class in net.sf.staccatocommons.check

A check failure that contains the name and value of the variable that was checked

Check.VarFailure(String, Object, String) - Constructor for class net.sf.staccatocommons.check.Check.VarFailure

Creates a new Check.VarFailure

contains(String, ContainsAware<T>, T) - Method in class net.sf.staccatocommons.check.Check

Checks that the variable contains the given element

createException(Check.Failure) - Method in class net.sf.staccatocommons.check.Check

createException(Check.Failure) - Method in class net.sf.staccatocommons.check.Validate

createMessage() - Method in class net.sf.staccatocommons.check.Check.Failure

createMessage() - Method in class net.sf.staccatocommons.check.Check.VarFailure

createSimpleMessage() - Method in class net.sf.staccatocommons.check.Check.VarFailure

createVarException(Check.VarFailure) - Method in class net.sf.staccatocommons.check.Check

D

DEFAULT_FORMATTING_STRING - Static variable in class net.sf.staccatocommons.check.format.VariableFormatter

The default formatting string.

E

Ensure - Class in net.sf.staccatocommons.check

Ensure is a utility class for performing precondition checks.

F

fail(String, Object, String) - Static method in class net.sf.staccatocommons.check.Assert

Shortcut to Assert.that().fail(varName,var,message,args)

fail(String, Object...) - Static method in class net.sf.staccatocommons.check.Assert

Shortcut to Assert.that().fail(message,args)

fail(String, Object...) - Method in class net.sf.staccatocommons.check.Check

Fails, throwing an exception with a message.

fail(String, Object, String, Object...) - Static method in class net.sf.staccatocommons.check.Ensure

Shortcut to Ensure.that().fail(varName,var,message,args)

fail(String, Object...) - Static method in class net.sf.staccatocommons.check.Ensure

Shortcut to Ensure.that().fail(message,args)

failVar(String, Object, String, Object...) - Method in class net.sf.staccatocommons.check.Check

Fails, throwing an exception with a message, the var and its name.

format(String, Object) - Static method in class net.sf.staccatocommons.check.format.Var

Creates a formatted string using the global VariableFormatter, for the given variable name an value

format(String, String, Object, String) - Static method in class net.sf.staccatocommons.check.format.Var

Creates a formatted string with a prefix and a suffix

format(String, String, Object) - Static method in class net.sf.staccatocommons.check.format.Var

Creates a formatted string with a prefix

format(String, Object, String) - Static method in class net.sf.staccatocommons.check.format.Var

Creates a formatted string with a suffix

format(String, Object) - Method in class net.sf.staccatocommons.check.format.VariableFormatter

Creates a string that shows the content of a variable

format(String, String, Object) - Method in class net.sf.staccatocommons.check.format.VariableFormatter

Creates a string that shows the content of a variable, preceded by a prefix

format(String, Object, String) - Method in class net.sf.staccatocommons.check.format.VariableFormatter

Creates a string that shows the content of a variable, followed by a suffix

format(String, String, Object, String) - Method in class net.sf.staccatocommons.check.format.VariableFormatter

Creates a string that shows the content of a variable, preceded by a prefix string and ended with a suffix string

G

getVar() - Method in class net.sf.staccatocommons.check.Check.VarFailure

getVarName() - Method in class net.sf.staccatocommons.check.Check.VarFailure

I

isBetween(String, T, T, T) - Method in class net.sf.staccatocommons.check.Check

Checks the var is not null, less than or equal to max and greater than or equal to min

isEmpty(String, Collection<?>) - Method in class net.sf.staccatocommons.check.Check

Checks that the variable is not null and empty

isEmpty(String, Map<?, ?>) - Method in class net.sf.staccatocommons.check.Check

Checks that the variable is not null and empty

isEmpty(String, Iterable<?>) - Method in class net.sf.staccatocommons.check.Check

Checks that the variable is not null and empty

isEmpty(String, CharSequence) - Method in class net.sf.staccatocommons.check.Check

Checks that the variable is not null and empty

isEmpty(String, EmptyAware) - Method in class net.sf.staccatocommons.check.Check

Checks that the variable is not null and empty

isEmpty(String, A, EmptyAwareType<A>) - Method in class net.sf.staccatocommons.check.Check

Checks that the variable is not null and empty

isFalse(String, boolean) - Method in class net.sf.staccatocommons.check.Check

Checks a that the variable is true, failing with a generated message if it is not.

isGreaterThan(String, T, T) - Method in class net.sf.staccatocommons.check.Check

Checks that the variable is not null and > than other

isGreaterThanOrEqualTo(String, T, T) - Method in class net.sf.staccatocommons.check.Check

Checks that the variable is not null and >= than other

isIn(String, T, ContainsAware<T>) - Method in class net.sf.staccatocommons.check.Check

Checks the var is not null and contained by the given container

isInstanceOf(String, Object, Class<?>) - Method in class net.sf.staccatocommons.check.Check

Checks that the variable is not null and instance of the given class

isLessThan(String, T, T) - Method in class net.sf.staccatocommons.check.Check

Checks that the variable is not null and < than other

isLessThanOrEqualTo(String, T, T) - Method in class net.sf.staccatocommons.check.Check

Checks that the variable is not null and <= than other

isMaxSize(String, Collection<?>, int) - Method in class net.sf.staccatocommons.check.Check

Checks that var is not null and its size less than or equals to the the given maxSize

isMaxSize(String, A, int, SizeAwareType<A>) - Method in class net.sf.staccatocommons.check.Check

Checks that var is not null and its size less than or equals to the the given maxSize

isMinSize(String, Collection<?>, int) - Method in class net.sf.staccatocommons.check.Check

Checks that var is not null and its size greater than or equals to the the given minSize

isMinSize(String, A, int, SizeAwareType<A>) - Method in class net.sf.staccatocommons.check.Check

Checks that var is not null and its size greater than or equals to the the given minSize

isNotEmpty(String, EmptyAware) - Method in class net.sf.staccatocommons.check.Check

Checks that the EmptyAware var is not null and not empty

isNotEmpty(String, Collection<?>) - Method in class net.sf.staccatocommons.check.Check

Checks that the Collection variable is not null and not empty

isNotEmpty(String, CharSequence) - Method in class net.sf.staccatocommons.check.Check

Checks that the CharSequence variable is not null and not empty

isNotEmpty(String, Map<?, ?>) - Method in class net.sf.staccatocommons.check.Check

Checks that the Map variable is not null and not empty

isNotEmpty(String, Iterable<?>) - Method in class net.sf.staccatocommons.check.Check

Checks that the Iterable variable is not null and not empty

isNotEmpty(String, A, EmptyAwareType<A>) - Method in class net.sf.staccatocommons.check.Check

Checks that the variable is not null and not empty

isNotNegative(String, long) - Method in class net.sf.staccatocommons.check.Check

Checks the variable is >= 0

isNotNegative(String, int) - Method in class net.sf.staccatocommons.check.Check

Checks the variable is >= 0

isNotNegative(String, double) - Method in class net.sf.staccatocommons.check.Check

Checks the variable is >= 0

isNotNegative(String, float) - Method in class net.sf.staccatocommons.check.Check

Checks the variable is >= 0

isNotNegative(String, BigDecimal) - Method in class net.sf.staccatocommons.check.Check

Checks the variable is >= 0

isNotNegative(String, BigInteger) - Method in class net.sf.staccatocommons.check.Check

Checks the variable is >= 0

isNotNegative(String, A, NumberType<A>) - Method in class net.sf.staccatocommons.check.Check

Checks the var is >= 0

isNotNull(String, Object) - Static method in class net.sf.staccatocommons.check.Assert

Shortcut to Assert.that().isNotNull(variableName, variable)

isNotNull(String, Object) - Method in class net.sf.staccatocommons.check.Check

Checks the variable is not null.

isNotNull(String, Object) - Static method in class net.sf.staccatocommons.check.Ensure

Shortcut to Ensure.that().isNotNull(variableName, variable)

isNotZero(String, A, NumberType<A>) - Method in class net.sf.staccatocommons.check.Check

Checks the var is not null and not equal to 0

isNull(String, Object) - Static method in class net.sf.staccatocommons.check.Assert

Shortcut to Assert.that().isNull(variableName, variable)

isNull(String, Object) - Method in class net.sf.staccatocommons.check.Check

Checks the variable is null.

isNull(String, Object) - Static method in class net.sf.staccatocommons.check.Ensure

Shortcut to Ensure.that().isNull(variableName, variable)

isPositive(String, long) - Method in class net.sf.staccatocommons.check.Check

Checks the var is > 0

isPositive(String, int) - Method in class net.sf.staccatocommons.check.Check

Checks the var is > 0

isPositive(String, double) - Method in class net.sf.staccatocommons.check.Check

Checks the var is > 0

isPositive(String, float) - Method in class net.sf.staccatocommons.check.Check

Checks the var is > 0

isPositive(String, BigDecimal) - Method in class net.sf.staccatocommons.check.Check

Checks the var is > 0

isPositive(String, BigInteger) - Method in class net.sf.staccatocommons.check.Check

Checks the var is not null and > 0

isPositive(String, A, NumberType<A>) - Method in class net.sf.staccatocommons.check.Check

Checks the var is > 0

isSize(String, Collection<?>, int) - Method in class net.sf.staccatocommons.check.Check

Checks that var is not null and its size is the given expectedSize

isSize(String, CharSequence, int) - Method in class net.sf.staccatocommons.check.Check

Checks that var is not null and its size is the given expectedSize

isSize(String, SizeAware, int) - Method in class net.sf.staccatocommons.check.Check

Checks that var is not null and its size is the given expectedSize

isSize(String, Map<?, ?>, int) - Method in class net.sf.staccatocommons.check.Check

Checks that var is not null and its size is the given expectedSize

isSize(String, A, int, SizeAwareType<A>) - Method in class net.sf.staccatocommons.check.Check

Checks that var is not null and its ize is the given expectedSize

isTrue(String, boolean) - Method in class net.sf.staccatocommons.check.Check

Checks a that the variable is true, failing with a generated message if it is not.

isZero(String, A, NumberType<A>) - Method in class net.sf.staccatocommons.check.Check

Checks the var is not null and equal to 0

M

matches(String, String, String) - Method in class net.sf.staccatocommons.check.Check

Checks that the variable is not null and matches a given regular expression.

matches(String, String, Pattern) - Method in class net.sf.staccatocommons.check.Check

Checks that the variable is not null and matches a given pattern

N

net.sf.staccatocommons.check - package net.sf.staccatocommons.check

This packages contains a generic validation system for fail-fast programming.

net.sf.staccatocommons.check.format - package net.sf.staccatocommons.check.format

This package contains classes that format variables - attributes, attributes, local variables or parameters - creating a string with its identifier and value

S

setVariableFormatter(VariableFormatter) - Static method in class net.sf.staccatocommons.check.format.Var

This method should never be invoker except during application startup

T

that(boolean, String, Object...) - Static method in class net.sf.staccatocommons.check.Assert

Shortcut to Assert.that().is(condition,message,args)

that() - Static method in class net.sf.staccatocommons.check.Assert

that(boolean, String, Object...) - Method in class net.sf.staccatocommons.check.Check

Checks a that a condition is true, failing if it is not.

that(boolean, String, Object...) - Static method in class net.sf.staccatocommons.check.Ensure

Shortcut to Ensure.that().is(condition,message,args)

that() - Static method in class net.sf.staccatocommons.check.Ensure

thatVar(String, Object, boolean, String, Object...) - Static method in class net.sf.staccatocommons.check.Assert

Shortcut to Assert.that().is(varName,var,condition,message,args)

thatVar(String, Object, boolean, String, Object...) - Method in class net.sf.staccatocommons.check.Check

Checks a condition, failing if not met.

thatVar(String, Object, boolean, String, Object...) - Static method in class net.sf.staccatocommons.check.Ensure

Shortcut to Ensure.that().is(varName,var,condition,message,args)

throwing(Class<E>) - Static method in class net.sf.staccatocommons.check.Validate

Created a new Validate that will throw an exception of the given class on failure

V

Validate<ExceptionType extends Throwable> - Class in net.sf.staccatocommons.check

Validate is a generic Check that on failure will throw a and exception of a parameterized class.

Var - Class in net.sf.staccatocommons.check.format

A class methods to create debug string for pairs of variables names and values

VariableFormatter - Class in net.sf.staccatocommons.check.format

A formatter that creates strings that show a variable content, for debugging and error messages.

VariableFormatter(String) - Constructor for class net.sf.staccatocommons.check.format.VariableFormatter

Creates a VariableFormatter with a custom formatting string, in the form of the formatting string expected by String.format(String, Object...).

VariableFormatter() - Constructor for class net.sf.staccatocommons.check.format.VariableFormatter

Creates a VariableFormatter with the default formatting string

A C D E F G I M N S T V