|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
ObjectCheckRepContract
public final class CheckRepContract extends Object implements ObjectContract
Represents the contract that an object should conform to its representation
invariant, as expressed in a user-supplied representation check method.A rep
check method for a class must be declared as a public instance method with no
parameters in the given class, annotated with a @CheckRep
annotation, and have return type boolean or void.
In the first case, a return value true means the check passed,
and false, or an exception, means it failed. In the second case,
normal return means the check passed, and an exception means it failed.
| Modifier and Type | Field and Description |
|---|---|
Method |
checkRepMethod
|
Class<?> |
declaringClass
|
| Constructor and Description |
|---|
CheckRepContract(Method checkRepMethod)
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object o)
|
boolean |
evalExceptionMeansFailure()
Communicates to Randoop how to interpret exceptional behavior from the evaluate method. |
boolean |
evaluate(Object... objects)
Evaluates the contract on the given values. |
String |
get_observer_str()
Returns a string describing the observer |
int |
getArity()
The number of values that this contract is over. |
int |
hashCode()
|
String |
toCodeString()
A string that can be used as Java source code and will result in the expression being evaluated. |
String |
toCommentString()
A string that will be inserted as a comment in the test before the code corresponding to this contract. |
| Methods inherited from class Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public final Method checkRepMethod
public final Class<?> declaringClass
| Constructor Detail |
|---|
public CheckRepContract(Method checkRepMethod)
| Method Detail |
|---|
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public boolean evaluate(Object... objects)
throws Throwable
ObjectContract
When calling this method during execution of a test, Randoop
guarantees that objects does not contain any
null objects, and that
objects.length == getArity().
This method should return true if the contract was
satisfied and false if it was violated.
evaluate in interface ObjectContractThrowablepublic int getArity()
ObjectContract
getArity in interface ObjectContractpublic String toCommentString()
ObjectContract
toCommentString in interface ObjectContractpublic String get_observer_str()
ObjectContract
get_observer_str in interface ObjectContractpublic boolean evalExceptionMeansFailure()
ObjectContractevaluate method.
If this method returns true, Randoop will interpret
an exception that escapes during evaluation as a failure of the
contract.
If the method returns false, Randoop will interpret
an exception as passing behavior.
evalExceptionMeansFailure in interface ObjectContractpublic String toCodeString()
ObjectContractThe string should be formatted as follows: the N-th object that participates in the contract check should be referred to as "xN" (for N one of 0, ... , 9). For example, if the expression or arity 2 represents a call of the equals method between two objects, the comment should be something like "x0.equals(x1)".
The returned string should not be null.
toCodeString in interface ObjectContract
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||