mockit.VerificationsInOrder Maven / Gradle / Ivy

Go to download
/*
 * JMockit Verifications
 * Copyright (c) 2006-2010 Rogério Liesenfeld
 * All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package mockit;

import mockit.internal.expectations.*;

/**
 * Same as {@link Verifications}, but checking that invocations in the replay phase occurred in the
 * same order as specified in this ordered verification block.
 * 
 * In the Tutorial
 *
 * @see #VerificationsInOrder()
 * @see #VerificationsInOrder(int)
 * @see #unverifiedInvocations()
 */
public class VerificationsInOrder extends Verifications
{
   /**
    * Begins in-order verification on the mocked types/instances invoked during the replay phase of the test.
    */
   protected VerificationsInOrder()
   {
      super(true);
   }

   /**
    * Begins in-order verification on the mocked types/instances invoked during the replay phase of the test.
    * 

    * The effect of specifying a number of iterations larger than 1 (one) is equivalent to duplicating (like in "copy &
    * paste") the whole sequence of invocations in the block.
    *
    * @param numberOfIterations the positive number of iterations for the whole set of invocations
    * verified inside the block; when not specified, 1 (one) iteration is assumed
    */
   protected VerificationsInOrder(int numberOfIterations)
   {
      super(true);
      verificationPhase.setNumberOfIterations(numberOfIterations);
   }

   /**
    * Accounts for a sequence of non-strict invocations executed in the replay phase that are not explicitly verified
    * in this block.
    * Note that even the invocations that are implicitly verified (due to a minimum invocation count specified in the
    * record phase) will be accounted for (if any), since their replay order cannot be verified otherwise.
    * (Obviously, this doesn't apply to strict invocations, whose replay order is always verified implicitly.)
    * 

    * Which invocations belong or not in this sequence depends on the relative position of the call to this method with
    * respect to the explicitly verified invocations in the same block.
    * 

    * This can be used to verify that one or more consecutive invocations occurred before others, and
    * conversely to verify that one or more consecutive invocations occurred after others.
    * The call to this method marks the position where the unverified invocations are expected to have occurred,
    * relative to the explicitly verified ones.
    * 

    * Each sequence of explicit verifications in the block will correspond to a consecutive sequence of
    * invocations in the replay phase of the test.
    * So, if this method is called more than once from the same verification block, then an arbitrary sequence of
    * consecutive invocations between said calls will be verified.
    * Notice that when this method is not used, the invocations in the replay phase need not be consecutive,
    * but only have the same relative order as the verification calls.
    * 

    * Finally, notice that you can combine an ordered block that verifies the position of some calls relative to others,
    * with an unordered block which verifies some or all of those other invocations.
    * 
    * In the Tutorial
    */
   protected final void unverifiedInvocations()
   {
      ((OrderedVerificationPhase) verificationPhase).fixPositionOfUnverifiedExpectations();
   }
}