randoop.contract

Class ObserverEqValue

java.lang.Object

randoop.contract.ObjectContract

randoop.contract.ObserverEqValue

public final class ObserverEqValue
extends ObjectContract

A check recording the value that an observer method returned during execution, e.g. a check recording that a collection's size() method returned 3.

ObserverEqValue checks are not checks that must hold of all objects of a given class (unlike a check like EqualsReflexive, which must hold for any objects, no matter its execution context).

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static TypeTuple	inputTypes The arguments to which this contract can be applied.
TypedOperation	observer The observer method.
java.lang.Object	value The run-time result of calling the observer: a primitive value or String.

Constructor Summary

Constructors

Constructor and Description
ObserverEqValue(TypedOperation observer, java.lang.Object value) Create a new ObserverEqValue.

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()
static boolean	isLiteralValue(java.lang.Object value) Returns true if the argument can be written as a literal in Java source code.
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.
java.lang.String	toString()

Methods inherited from class randoop.contract.ObjectContract

checkContract, failedContract, toStringHandleExceptions

Methods inherited from class java.lang.Object

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

Field Detail

observer

public TypedOperation observer

The observer method.

value

public java.lang.Object value

The run-time result of calling the observer: a primitive value or String.

inputTypes

static TypeTuple inputTypes

The arguments to which this contract can be applied.

Constructor Detail

ObserverEqValue

public ObserverEqValue(TypedOperation observer,
                       java.lang.Object value)

Create a new ObserverEqValue.

Parameters:

observer - the observer method

value - the run-time result of calling the observer: a primitive value or String

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

isLiteralValue

public static boolean isLiteralValue(java.lang.Object value)

Returns true if the argument can be written as a literal in Java source code.

Parameters:

value - the value to be tested

Returns:

true if the argument can be written as a literal in Java source code

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

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object