Package randoop.contract

Class CompareToSubs

java.lang.Object
randoop.contract.ObjectContract
randoop.contract.CompareToSubs
public class CompareToSubs extends ObjectContract
The contract: Checks the substitutability property of compareTo for equals. 
(x0.compareTo(x1) == 0)
 → (Math.signum(x0.compareTo(x2)) == Math.signum(x1.compareTo(x2)))

  • Field Details

    • instance

      private static final CompareToSubs instance

    • inputTypes

      static TypeTuple inputTypes
      The arguments to which this contract can be applied.

  • Constructor Details

    • CompareToSubs

      private CompareToSubs()

  • Method Details

    • getInstance

      public static CompareToSubs getInstance()

    • evaluate

      public boolean evaluate(Object... objects)
      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

    • 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 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 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 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