randoop.contract

Class CheckRepContract

java.lang.Object

randoop.contract.ObjectContract

randoop.contract.CheckRepContract

public final class CheckRepContract
extends ObjectContract

Represents the contract that an object must 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.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.reflect.Method	checkRepMethod
java.lang.Class<?>	declaringClass
private TypedClassOperation	operation
(package private) boolean	returnsBoolean

Constructor Summary

Constructors

Constructor and Description
CheckRepContract(java.lang.reflect.Method checkRepMethod)

Method Summary

Modifier and Type	Method and Description
boolean	equals(@Nullable java.lang.Object o)
boolean	evaluate(java.lang.Object... objects) Evaluates the contract on the given values.
java.lang.String	get_observer_str() Returns a string describing the observer.
int	getArity() The number of values that this contract is over.
TypeTuple	getInputTypes() Returns the input types for this contract.
int	hashCode()
java.lang.String	toCodeString() A string that can be used as Java source code and will result in the expression being evaluated.
java.lang.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 randoop.contract.ObjectContract

checkContract, failedContract, toStringHandleExceptions

Methods inherited from class java.lang.Object

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

Field Detail

checkRepMethod

public final java.lang.reflect.Method checkRepMethod

operation

private final TypedClassOperation operation

returnsBoolean

boolean returnsBoolean

declaringClass

public final java.lang.Class<?> declaringClass

Constructor Detail

CheckRepContract

public CheckRepContract(java.lang.reflect.Method checkRepMethod)

Method Detail

equals

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

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

evaluate

public boolean evaluate(java.lang.Object... objects)
                 throws java.lang.Throwable

Description copied from class: ObjectContract

Evaluates the contract on the given values. Returns false if the contract was violated. Returns true if the contract was satisfied or was not applicable.

When calling this method during execution of a test, Randoop guarantees that objects does not contain any null objects, and that objects.length == getArity().

Specified by:

evaluate in class ObjectContract

Parameters:

objects - the actual parameters to this contract

Returns:

false if the contract is violated, true otherwise

Throws:

java.lang.Throwable - if an exception is thrown in evaluation

getArity

public int getArity()

Description copied from class: ObjectContract

The number of values that this contract is over.

Specified by:

getArity in class ObjectContract

Returns:

the number of arguments to the contract

getInputTypes

public TypeTuple getInputTypes()

Description copied from class: ObjectContract

Returns the input types for this contract.

Specified by:

getInputTypes in class ObjectContract

Returns:

the input types for this contract

toCommentString

public java.lang.String toCommentString()

Description copied from class: ObjectContract

A string that will be inserted as a comment in the test before the code corresponding to this contract. Occurrences of variables x0, x1, x2, etc. in the string will be replaced by actual values.

Specified by:

toCommentString in class ObjectContract

Returns:

the comment string representation of this contract

get_observer_str

public java.lang.String get_observer_str()

Description copied from class: ObjectContract

Returns a string describing the observer.

Specified by:

get_observer_str in class ObjectContract

Returns:

a string description of the contract

toCodeString

public java.lang.String toCodeString()

Description copied from class: ObjectContract

A string that can be used as Java source code and will result in the expression being evaluated.

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 of arity 2 represents a call of the equals method between two objects, the code should be something like assert x0.equals(x1);".

The string does not contain a trailing newline. When there is a leading comment, it should start with a newline.

Specified by:

toCodeString in class ObjectContract

Returns:

the code string representation of this contract; must be non-null