randoop.test

Class ExceptionCheck

java.lang.Object

randoop.test.ExceptionCheck

All Implemented Interfaces:

Check

Direct Known Subclasses:

EmptyExceptionCheck, ExpectedExceptionCheck, InvalidExceptionCheck

public abstract class ExceptionCheck
extends java.lang.Object
implements Check

An ExceptionCheck indicates that an exception is expected at a particular statement in a sequence.

When test code is generated in ExecutableSequence.toCodeString(), the methods toCodeStringPreStatement() and toCodeStringPostStatement() wrap the statement in a try-catch block for the exception, while the implementing classes define appendTryBehavior(java.lang.StringBuilder) and appendCatchBehavior(java.lang.StringBuilder) which handle differences in whether assertions are generated to enforce the expectation of the exception.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	catchClassName The name of exception to be caught.
protected java.lang.Throwable	exception The thrown exception.
(package private) int	statementIndex Indicates which statement results in the given exception.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExceptionCheck(java.lang.Throwable exception, int statementIndex, java.lang.String catchClassName) Creates an exception check for the statement at the statement index.

Method Summary

Modifier and Type	Method and Description
protected abstract void	appendCatchBehavior(java.lang.StringBuilder b) Appends code for catch block behavior corresponding to an expected exception.
protected abstract void	appendTryBehavior(java.lang.StringBuilder b) Appends code to follow the statement throwing expected exception in try block.
boolean	equals(@Nullable java.lang.Object o) Determines if two ExceptionCheck objects are equal.
java.lang.Throwable	getException() Returns the exception.
@Nullable java.lang.String	getExceptionName() Returns the name of the exception class.
int	hashCode()
java.lang.String	toCodeStringPostStatement() Returns a string of Java source code to be emitted after a statement containing this check.
java.lang.String	toCodeStringPreStatement() Returns a string of Java source code to be emitted before a statement containing this check.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

exception

protected final java.lang.Throwable exception

The thrown exception.

statementIndex

final int statementIndex

Indicates which statement results in the given exception.

catchClassName

private java.lang.String catchClassName

The name of exception to be caught. This might be a supertype of exception's class C, for instance because C is private or because the method is declared to throw a superclass of C.

Constructor Detail

ExceptionCheck

protected ExceptionCheck(java.lang.Throwable exception,
                         int statementIndex,
                         java.lang.String catchClassName)

Creates an exception check for the statement at the statement index. The generated code for this check will include a try-catch block with behaviors determined by implementing sub-classes.

Parameters:

exception - the exception expected at the statement index

statementIndex - the position of the statement in a sequence

catchClassName - the name of exception to be caught

Method Detail

equals

public boolean equals(@Nullable java.lang.Object o)

Determines if two ExceptionCheck objects are equal. Assumes that implementing classes have no state.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toCodeStringPreStatement

public final java.lang.String toCodeStringPreStatement()

Returns a string of Java source code to be emitted before a statement containing this check.

The pre-statement prefix of the try-catch wrapper.

Specified by:

toCodeStringPreStatement in interface Check

Returns:

the string to be included before the statement

toCodeStringPostStatement

public final java.lang.String toCodeStringPostStatement()

Returns a string of Java source code to be emitted after a statement containing this check.

Returns the post-statement portion of the try-catch wrapper. Starts with post-statement try-behavior as determined by a subclass implementation of appendTryBehavior(java.lang.StringBuilder), and then closes with the catch clause with the body determined by the sub-class implementation of appendCatchBehavior(java.lang.StringBuilder). Catches this exception or the closest public superclass of the exception.

Specified by:

toCodeStringPostStatement in interface Check

Returns:

the post-statement code text for the expected exception

appendCatchBehavior

protected abstract void appendCatchBehavior(java.lang.StringBuilder b)

Appends code for catch block behavior corresponding to an expected exception.

Parameters:

b - the string builder to which code text is to be added

appendTryBehavior

protected abstract void appendTryBehavior(java.lang.StringBuilder b)

Appends code to follow the statement throwing expected exception in try block.

Parameters:

b - the string builder to which code text is added

getExceptionName

public @Nullable java.lang.String getExceptionName()

Returns the name of the exception class.

Returns:

the canonical name of the exception class

getException

public java.lang.Throwable getException()

Returns the exception.

Returns:

the exception in this check