org.scalautils.Constraint.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scalatest_2.11.0-RC2 Show documentation

ScalaTest is a free, open-source testing toolkit for Scala and Java programmers.

The newest version!

/*
 * Copyright 2001-2013 Artima, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.scalautils

import annotation.implicitNotFound

/**
 * Abstract class used to enforce type constraints for equality checks.
 *
 * 
 * For more information on how this class is used, see the documentation of TripleEqualsSupport.
 * 
 */
@implicitNotFound(msg = "types ${A} and ${B} do not adhere to the type constraint selected for the === and !== operators; the missing implicit parameter is of type org.scalautils.Constraint[${A},${B}]")
abstract class Constraint[A, B] {

  /**
   * Indicates whether the objects passed as a and b are equal.
   *
   * @param a a left-hand-side object being compared with another (right-hand-side one) for equality (e.g., a == b)
   * @param b a right-hand-side object being compared with another (left-hand-side one) for equality (e.g., a == b)
   */
  def areEqual(a: A, b: B): Boolean
}