org.scalatest.matchers.LazyArg.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-M5 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.matchers

/**
 * Lazy argument used for lazy message construction.
 *
 * @param arg the argument
 */
sealed abstract class LazyArg(val arg: Any)

/**
 * Singleton object that provides factory apply method to create LazyArg with passed
 * argument and a function that takes the argument's toString and return a result String.
 *
 * @author Bill Venners
 * @author Chee Seng
 */
object LazyArg {

  /**
   * Factory method to create LazyArg with passed argument and a function that takes the argument's toString
   * and return a result String.
   *
   * @param arg a argument
   * @param f a function that takes arg.toString and return a result String
   * @return an instance of LazyArg
   */
  def apply(arg: Any)(f: Any => String) =
    new LazyArg(arg) {
      override def toString = f(arg.toString)
    }
}