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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scalautils_2.11 Show documentation

ScalaUtils is an open-source library for Scala projects that contains portions of the ScalaTest project that may make sense to use in production.

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

/**
 * A default Equality type class implementation (which can be used for any type) whose
 * areEqual method compares the passed objects with ==, calling .deep
 * first on any passed object that is an array.
 * 
 */
private[scalautils] final class DefaultEquality[A] extends Equality[A] {

  /**
   * Indicates whether the objects passed as a and b are equal by invoking == on a
   * passing in b, treating arrays specially by invoking .deep on a and/or b if they
   * are arrays, and using the result or results of invoking .deep in the equality check.
   *
   * @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: Any): Boolean = {
    a match {
      case arr: Array[_] =>
        b match {
          case brr: Array[_] => arr.deep == brr.deep
          case _ => arr.deep == b
        }
      case _ => {
        b match {
          case brr: Array[_] => a == brr.deep
          case _ => a == b
        }
      }
    }
  }

  override def toString: String = "Equality.default"
}