org.spf4j.test.log.annotations

Annotation Type ExpectLog

@Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Repeatable(value=ExpectLogs.class)
public @interface ExpectLog

Annotation to assert log behavior. This annotation will describe a expected log event. If this expected log event will not happen during the unit test execution, the unit test will fail.

Author:

Zoltan Farkas

See Also:

org.spf4j.test.log.annotations

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	category
Class<?>	categoryClass
long	expectationTimeout
Level	level
String	messageRegexp
int	nrTimes
TimeUnit	timeUnit

Element Detail

category

public abstract String category

Returns:

the log category to expect. ("" is the root category).

Default:

""

categoryClass

public abstract Class<?> categoryClass

Returns:

the log category to expect. (Void.class is the root category and default).

Default:

java.lang.Void.class

level

public abstract Level level

Returns:

expected log level.

Default:

org.spf4j.log.Level.ERROR

messageRegexp

public abstract String messageRegexp

Returns:

regexp of expected log message.

Default:

".*"

nrTimes

public abstract int nrTimes

Returns:

nr of times the expectation to be asserted.

Default:

1

expectationTimeout

public abstract long expectationTimeout

Returns:

the number of TU to wait for a log message after the unit test execution is finished.

Default:

0L

timeUnit

public abstract TimeUnit timeUnit

Returns:

expectation timeout unit.

Default:

java.util.concurrent.TimeUnit.MILLISECONDS