org.helenus.junit.rules

Class MethodRule

java.lang.Object

org.helenus.junit.rules.MethodRule

All Implemented Interfaces:

org.junit.rules.MethodRule

public class MethodRule
extends Object
implements org.junit.rules.MethodRule

The MethodRule class provides a JUnit4 method rule which enables additional useful functionalities for test cases.

Since:

1.0

Version:

1 - Jul 1, 2015 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2015 The Helenus Driver Project Authors

Constructor Summary

Constructors

Constructor and Description
MethodRule(EConsumer<MethodRule,Exception>... handlers) Instantiates a new MethodRule object.

Method Summary

Modifier and Type	Method and Description
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runners.model.FrameworkMethod method, Object target)
int	getLineNumber() Gets the line number for the test method if available.
String	getName() Gets the name of the test method being executed.
String	getSourceFile() Gets the source file for the test method if available.
boolean	hasTag(String tag) Checks if the method is annotated with the specified tag.
MethodRule	onFailure(EConsumer<Throwable,Exception> handler) Register an error handler to be called on failure of the current test case.
MethodRule	onFailure(ERunnable<Exception> handler) Register an error handler to be called on failure of the current test case.

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodRule

@SafeVarargs
public MethodRule(EConsumer<MethodRule,Exception>... handlers)

Instantiates a new MethodRule object.

Parameters:

handlers - optional start handlers to invoke before the test case starts

Method Detail

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runners.model.FrameworkMethod method,
                                               Object target)

Specified by:

apply in interface org.junit.rules.MethodRule

See Also:

MethodRule.apply(org.junit.runners.model.Statement, org.junit.runners.model.FrameworkMethod, java.lang.Object)

getName

public String getName()

Gets the name of the test method being executed.

Returns:

the name of the test method being executed

getSourceFile

public String getSourceFile()

Gets the source file for the test method if available.

Returns:

the source file where the test method is defined or null if not available

getLineNumber

public int getLineNumber()

Gets the line number for the test method if available.

Returns:

the line number of the source line corresponding to the test method or -1 if not available

hasTag

public boolean hasTag(String tag)

Checks if the method is annotated with the specified tag.

Parameters:

tag - the tag to check if the current test method is annotated with

Returns:

true if the test method is annotated with the specified tag; false otherwise

See Also:

Tag

onFailure

public MethodRule onFailure(ERunnable<Exception> handler)

Register an error handler to be called on failure of the current test case.

Parameters:

handler - the error handler to be called on failure of the test case

Returns:

this for chaining

onFailure

public MethodRule onFailure(EConsumer<Throwable,Exception> handler)

Register an error handler to be called on failure of the current test case.

Parameters:

handler - the error handler to be called on failure of the test case

Returns:

this for chaining