net.openhft.chronicle.core.io

Class ValidatableUtil

java.lang.Object

net.openhft.chronicle.core.io.ValidatableUtil

public class ValidatableUtil
extends Object

Utility methods to validate Validatable objects and control when the checks occur.

Constructor Summary

Constructors

Constructor and Description
ValidatableUtil()

Method Summary

Modifier and Type	Method and Description
static void	endValidateDisabled() Ends the block started with startValidateDisabled().
static void	requireNonNull(Object tested, String name) requires that a reference not be null, or throw an InvalidMarshallableException with an appropriate message
static void	requireTrue(boolean test, String msg) requires a test flag be true, otherwise throw an InvalidMarshallableException with the message provided
static void	startValidateDisabled() Starts a nestable block where validation is disabled.
static <T> T	validate(T t) Check an object is valid if it implements Validatable.
static boolean	validateEnabled() Checks if validation is enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidatableUtil

public ValidatableUtil()

Method Detail

validateEnabled

public static boolean validateEnabled()

Checks if validation is enabled.

Returns:

true if validation is enabled, false otherwise.

startValidateDisabled

public static void startValidateDisabled()

Starts a nestable block where validation is disabled. Use this around logging or diagnostic code that might operate on a partially initialised object.

endValidateDisabled

public static void endValidateDisabled()

Ends the block started with startValidateDisabled().

validate

public static <T> T validate(T t)
                      throws InvalidMarshallableException

Check an object is valid if it implements Validatable.

For logging purposes validation can be turned off e.g. for toString() with the following pattern

 ValidatableUtil.startValidatableDisabled();
 try {
   // some code
 } finally {
    ValidatableUtil.endValidateDisabled();
 }
 

Type Parameters:

T - type of object

Parameters:

t - object to validate

Returns:

the same object

Throws:

InvalidMarshallableException - if validate() method fails

requireNonNull

public static void requireNonNull(Object tested,
                                  String name)
                           throws InvalidMarshallableException

requires that a reference not be null, or throw an InvalidMarshallableException with an appropriate message

Parameters:

tested - reference

name - of reference

Throws:

InvalidMarshallableException - if tested is null

requireTrue

public static void requireTrue(boolean test,
                               String msg)
                        throws InvalidMarshallableException

requires a test flag be true, otherwise throw an InvalidMarshallableException with the message provided

Parameters:

test - to check for true

msg - to use if false

Throws:

InvalidMarshallableException - to throw is false