org.helenus.driver.junit

Class StatementCaptureList<T extends GenericStatement>

java.lang.Object

org.helenus.driver.junit.StatementCaptureList<T>

Type Parameters:

T - the type of statements to capture

public class StatementCaptureList<T extends GenericStatement>
extends Object

The StatementCaptureList class defines a class capable of capturing executing statements.

Since:

1.0

Version:

1 - Jun 30, 2015 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2015 The Helenus Driver Project Authors

Method Summary

Modifier and Type	Method and Description
StatementCaptureList<T>	andExpect(org.hamcrest.Matcher<StatementCaptureList<T>> matcher) Provides an expectation for the statement capture list.
StatementCaptureList<T>	andExpect(StatementCaptureListMatcher<T> matcher) Provides an expectation for the statement capture list.
StatementCaptureList<T>	dump(Logger logger, Level level) Dumps the content of the capture list.
StatementCaptureList<T>	fail(int num, RuntimeException e) Registers an interceptor to intercept the next num executing statements to throw back the specified error.
StatementCaptureList<T>	fail(RuntimeException e) Registers an interceptor to intercept all executing statement to throw back the specified error.
StatementCaptureList<T>	intercept(java.util.function.Consumer<T> consumer) Registers a consumer to intercept all executing statement.
StatementCaptureList<T>	intercept(int num, java.util.function.Consumer<T> consumer) Registers a consumer to intercept the next num executing statements.
boolean	isEmpty() Checks if this list did not capture any statements.
T	on(int i) Gets the ith captured statement if available.
int	size() Gets the number of statements captured.
StatementCaptureList<T>	stop() Stops capturing and intercepting statements with this capture list.
StatementCaptureList<T>	stopIntercepting() Stops all registered interceptors.

Methods inherited from class java.lang.Object

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

Method Detail

stop

public StatementCaptureList<T> stop()

Stops capturing and intercepting statements with this capture list.

Returns:

this for chaining

dump

public StatementCaptureList<T> dump(Logger logger,
                                    Level level)

Dumps the content of the capture list.

Parameters:

logger - the logger where to dump the content of this capture list

level - the log level to use when dumping

Returns:

this for chaining

size

public int size()

Gets the number of statements captured.

Returns:

the number of statements captured

isEmpty

public boolean isEmpty()

Checks if this list did not capture any statements.

Returns:

true if this list did not capture any statements; false otherwise

intercept

public StatementCaptureList<T> intercept(java.util.function.Consumer<T> consumer)

Registers a consumer to intercept all executing statement. An interceptor gets called just before the statement is submitted to Cassandra. Upon returning control from the interceptor, the statement will be submitted to Cassandra unless an exception was thrown out.

Parameters:

consumer - the consumer to call in order to intercept all statements

Returns:

this for chaining

Throws:

NullPointerException - if consumer is null

intercept

public StatementCaptureList<T> intercept(int num,
                                         java.util.function.Consumer<T> consumer)

Registers a consumer to intercept the next num executing statements. An interceptor gets called just before the statement is submitted to Cassandra. Upon returning control from the interceptor, the statement will be submitted to Cassandra unless an exception was thrown out.

Parameters:

num - the number of times this interceptor should remain active

consumer - the consumer to call in order to intercept the next statements

Returns:

this for chaining

Throws:

NullPointerException - if consumer is null

fail

public StatementCaptureList<T> fail(RuntimeException e)

Registers an interceptor to intercept all executing statement to throw back the specified error. An interceptor gets called just before the statement is submitted to Cassandra.

Note: The same exception is throw back each time a statement is intercepted and will have its stack trace re-filled every time.

Parameters:

e - the error to throw back when intercepting all statements

Returns:

this for chaining

Throws:

NullPointerException - if e is null

fail

public StatementCaptureList<T> fail(int num,
                                    RuntimeException e)

Registers an interceptor to intercept the next num executing statements to throw back the specified error. An interceptor gets called just before the statement is submitted to Cassandra.

Note: The same exception is throw back each time a statement is intercepted and will have its stack trace re-filled every time.

Parameters:

num - the number of times this interceptor should remain active

e - the error to throw back when intercepting the next statements

Returns:

this for chaining

Throws:

NullPointerException - if e is null

stopIntercepting

public StatementCaptureList<T> stopIntercepting()

Stops all registered interceptors.

Returns:

this for chaining

on

public T on(int i)

Gets the ith captured statement if available.

Parameters:

i - the captured statements (0-based)

Returns:

the corresponding non-null statement

Throws:

AssertionError - if less statements were captured

andExpect

public StatementCaptureList<T> andExpect(StatementCaptureListMatcher<T> matcher)
                                  throws Exception

Provides an expectation for the statement capture list.

Parameters:

matcher - the statement capture list matcher to use

Returns:

this for chaining

Throws:

Exception - if an error occurs

andExpect

public StatementCaptureList<T> andExpect(org.hamcrest.Matcher<StatementCaptureList<T>> matcher)
                                  throws Exception

Provides an expectation for the statement capture list.

Parameters:

matcher - the statement capture list matcher to use

Returns:

this for chaining

Throws:

Exception - if an error occurs