org.jredis.ri.alphazero.support

Class Assert

java.lang.Object

org.jredis.ri.alphazero.support.Assert

public class Assert
extends java.lang.Object

[TODO: document me!]

Since:

alpha.0

Version:

alpha.0, Apr 02, 2009

Constructor Summary

Constructors

Constructor and Description
Assert()

Method Summary

Modifier and Type	Method and Description
static <T,E extends java.lang.RuntimeException> T	cast(java.lang.Object obj, java.lang.Class<T> clazz, java.lang.String info, java.lang.Class<E> throwable) Tests to see if the object can be cast to the specified type.
static <E extends java.lang.RuntimeException> int	inRange(int n, int from, int to, java.lang.String info, java.lang.Class<E> clazz) Note: asserts n is in the range from->to, inclusive.
static <E extends java.lang.RuntimeException> long	inRange(long n, long from, long to, java.lang.String info, java.lang.Class<E> clazz)
static <E extends java.lang.RuntimeException> void	isEquivalent(byte[] a, byte[] b) assert identical based on content.
static <E extends java.lang.RuntimeException> void	isEquivalent(byte[] a, byte[] b, java.lang.Class<E> clazz) assert identical based on content.
static <E extends java.lang.RuntimeException> void	isTrue(boolean fact, java.lang.Class<E> clazz) Usage:
static <E extends java.lang.RuntimeException> void	isTrue(boolean fact, java.lang.String claim, java.lang.Class<E> clazz) Usage:
static <T,E extends java.lang.RuntimeException> T	notNull(T obj, java.lang.Class<E> clazz) Usage:
static <T,E extends java.lang.RuntimeException> T	notNull(T obj, int idx, java.lang.Class<E> clazz)
static <T,E extends java.lang.RuntimeException> T	notNull(T obj, java.lang.String info, java.lang.Class<E> clazz) Usage:
private static <E extends java.lang.RuntimeException> void	throwIt(java.lang.String msg, java.lang.Class<E> clazz) Not really intended for external use since you could simply throw new E (msg).

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 java.lang.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 java.lang.RuntimeException> void isEquivalent(byte[] a,
                                                                             byte[] b,
                                                                             java.lang.Class<E> clazz)

assert identical based on content.

Type Parameters:

E -

Parameters:

a -

b -

clazz -

notNull

public static final <T,E extends java.lang.RuntimeException> T notNull(T obj,
                                                                       java.lang.Class<E> clazz)
                                                                throws E extends java.lang.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 java.lang.RuntimeException

notNull

public static final <T,E extends java.lang.RuntimeException> T notNull(T obj,
                                                                       java.lang.String info,
                                                                       java.lang.Class<E> clazz)
                                                                throws E extends java.lang.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 java.lang.RuntimeException

notNull

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

Throws:

E extends java.lang.RuntimeException

isTrue

public static final <E extends java.lang.RuntimeException> void isTrue(boolean fact,
                                                                       java.lang.String claim,
                                                                       java.lang.Class<E> clazz)
                                                                throws E extends java.lang.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 java.lang.RuntimeException

isTrue

public static final <E extends java.lang.RuntimeException> void isTrue(boolean fact,
                                                                       java.lang.Class<E> clazz)
                                                                throws E extends java.lang.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 java.lang.RuntimeException

inRange

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

Type Parameters:

E -

Parameters:

n -

from -

to -

info -

clazz -

Returns:

Throws:

E

E extends java.lang.RuntimeException

inRange

public static final <E extends java.lang.RuntimeException> int inRange(int n,
                                                                       int from,
                                                                       int to,
                                                                       java.lang.String info,
                                                                       java.lang.Class<E> clazz)
                                                                throws E extends java.lang.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 java.lang.RuntimeException

cast

public static final <T,E extends java.lang.RuntimeException> T cast(java.lang.Object obj,
                                                                    java.lang.Class<T> clazz,
                                                                    java.lang.String info,
                                                                    java.lang.Class<E> throwable)
                                                             throws E extends java.lang.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 java.lang.RuntimeException

throwIt

private static final <E extends java.lang.RuntimeException> void throwIt(java.lang.String msg,
                                                                         java.lang.Class<E> clazz)
                                                                  throws E extends java.lang.RuntimeException

Not really intended for external use since you could simply throw new E (msg).

Usage (if you must):

 // ... somewhere within the bowels of your code ..
 //
 Assert.throwIt ("why am i calling Assert.throwIt() when I could be throwing myself?", YourRuntimeException.class);
  

Type Parameters:

E - RuntimeException subclass to to throw

Parameters:

msg - message to set in the exception

clazz - the Class of E

Throws:

E - your requested exception (unless reflection instantiate failed, in which case it will be a plain old RuntimeException)

E extends java.lang.RuntimeException