org.scalatest.words.ResultOfLessThanOrEqualToComparison.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.scalatest.words

import org.scalautils.Prettifier

/**
 * This class is part of the ScalaTest matchers DSL. Please see the documentation for Matchers for an overview of
 * the matchers DSL.
 *
 * @author Bill Venners
 */
final class ResultOfLessThanOrEqualToComparison[T : Ordering](val right: T) {

  /**
   * This method is invoked by be methods to which instances of this class are passed, which
   * enables syntax such as:
   *
   *    * result should not be <= (7)
   *                   ^  ... invoked by this be method
   * 
   *
   * 
   * or
   * 
   *
   *    * num should (not be <= (10) and not be > (17))
   *                 ^  ... invoked by this be method
   * 
   */
  def apply(left: T): Boolean = {
    val ordering = implicitly[Ordering[T]]
    ordering.lteq(left, right) // left <= right
  }
  
  /**
   * Override toString to return "<= ([right])"
   */
  override def toString: String = "<= (" + Prettifier.default(right) + ")"
}