org.jredis.ri.alphazero.support

Class Assert

java.lang.Object

org.jredis.ri.alphazero.support.Assert

public class Assert
extends Object

[TODO: document me!]

Since:

alpha.0

Version:

alpha.0, Apr 02, 2009

Author:

Joubin Houshyar (alphazero@sensesay.net)

Constructor Summary

Constructors

Constructor and Description
Assert()

Method Summary

Modifier and Type	Method and Description
static <T,E extends RuntimeException> T	cast(Object obj, Class<T> clazz, String info, Class<E> throwable) Tests to see if the object can be cast to the specified type.
static <E extends RuntimeException> int	inRange(int n, int from, int to, String info, Class<E> clazz) Note: asserts n is in the range from->to, inclusive.
static <E extends RuntimeException> long	inRange(long n, long from, long to, String info, Class<E> clazz)
static <E extends RuntimeException> void	isEquivalent(byte[] a, byte[] b) assert identical based on content.
static <E extends RuntimeException> void	isEquivalent(byte[] a, byte[] b, Class<E> clazz) assert identical based on content.
static <E extends RuntimeException> void	isTrue(boolean fact, Class<E> clazz) Usage:
static <E extends RuntimeException> void	isTrue(boolean fact, String claim, Class<E> clazz) Usage:
static <T,E extends RuntimeException> T	notNull(T obj, Class<E> clazz) Usage:
static <T,E extends RuntimeException> T	notNull(T obj, int idx, Class<E> clazz)
static <T,E extends RuntimeException> T	notNull(T obj, String info, Class<E> clazz) Usage:

Methods inherited from class java.lang.Object

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

Constructor Detail

Assert

public Assert()

Method Detail

isEquivalent

public static final <E extends RuntimeException> void isEquivalent(byte[] a,
                                                                   byte[] b)

assert identical based on content.

Type Parameters:

E -

Parameters:

a -

b -

clazz -

isEquivalent

public static final <E extends RuntimeException> void isEquivalent(byte[] a,
                                                                   byte[] b,
                                                                   Class<E> clazz)

assert identical based on content.

Type Parameters:

E -

Parameters:

a -

b -

clazz -

notNull

public static final <T,E extends RuntimeException> T notNull(T obj,
                                                             Class<E> clazz)
                                                      throws E extends RuntimeException

Usage:

 // ... somewhere within the bowels of your code ..
 //
 Assert.notNull (aReference, YourRuntimeException.class);
  

Type Parameters:

T -

E -

Parameters:

obj -

clazz -

Returns:

Throws:

E

E extends RuntimeException

notNull

public static final <T,E extends RuntimeException> T notNull(T obj,
                                                             String info,
                                                             Class<E> clazz)
                                                      throws E extends RuntimeException

Usage:

 // ... somewhere within the bowels of your code ..
 //
 Assert.notNull (inputRecord, "inputRecord", YourRuntimeException.class);
  

Type Parameters:

T -

E -

Parameters:

obj -

info -

clazz -

Returns:

Throws:

E

E extends RuntimeException

notNull

public static final <T,E extends RuntimeException> T notNull(T obj,
                                                             int idx,
                                                             Class<E> clazz)
                                                      throws E extends RuntimeException

Throws:

E extends RuntimeException

isTrue

public static final <E extends RuntimeException> void isTrue(boolean fact,
                                                             String claim,
                                                             Class<E> clazz)
                                                      throws E extends RuntimeException

Usage:

 // ... somewhere within the bowels of your code ..
 //
 Assert.isTrue (conn.isReady(), "connection is ready", YourRuntimeException.class);
  

Type Parameters:

E -

Parameters:

fact -

claim -

clazz -

Throws:

E

E extends RuntimeException

isTrue

public static final <E extends RuntimeException> void isTrue(boolean fact,
                                                             Class<E> clazz)
                                                      throws E extends RuntimeException

Usage:

 // ... somewhere within the bowels of your code ..
 //
 Assert.isTrue (conn.isReady(), YourRuntimeException.class);
  

Type Parameters:

E - is what you wish thrown - must be related to RuntimeException

Parameters:

fact -

clazz -

Throws:

E

E extends RuntimeException

inRange

public static final <E extends RuntimeException> long inRange(long n,
                                                              long from,
                                                              long to,
                                                              String info,
                                                              Class<E> clazz)
                                                       throws E extends RuntimeException

Type Parameters:

E -

Parameters:

n -

from -

to -

info -

clazz -

Returns:

Throws:

E

E extends RuntimeException

inRange

public static final <E extends RuntimeException> int inRange(int n,
                                                             int from,
                                                             int to,
                                                             String info,
                                                             Class<E> clazz)
                                                      throws E extends RuntimeException

Note: asserts n is in the range from->to, inclusive.

Type Parameters:

E -

Parameters:

n -

from -

to -

info -

clazz -

Returns:

Throws:

E

E extends RuntimeException

cast

public static final <T,E extends RuntimeException> T cast(Object obj,
                                                          Class<T> clazz,
                                                          String info,
                                                          Class<E> throwable)
                                                   throws E extends RuntimeException

Tests to see if the object can be cast to the specified type. Will not test to see arguments are not null.

Type Parameters:

T - the type

E - the thrown exception type

Parameters:

obj - the object to be cast

clazz - of the the target type

info - the message for the exception thrown

throwable - specified if not

Returns:

the cast object if successful

Throws:

E

E extends RuntimeException