org.scalactic.package.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scalatest-app_3 Show documentation
scalatest-app
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

import scala.util.control.NonFatal

package object scalactic {

  /**
   * Type alias for String.
   */
  type ErrorMessage = String

  /**
   * Returns the result of evaluating the given block f, wrapped in a Good, or
   * if an exception is thrown, the Throwable, wrapped in a Bad.
   *
   * 
   * Here are some examples:
   * 
   *
   *    * scala> import org.scalactic._
   * import org.scalactic._
   *
   * scala> attempt { 2 / 1 }
   * res0: org.scalactic.Or[Int,Throwable] = Good(2)
   *
   * scala> attempt { 2 / 0 }
   * res1: org.scalactic.Or[Int,Throwable] = Bad(java.lang.ArithmeticException: / by zero)
   * 
   *
   * @param f the block to attempt to evaluate
   * @return the result of evaluating the block, wrapped in a Good, or the
   *     thrown exception, wrapped in a Bad
   */
  def attempt[R](f: => R): R Or Throwable =
    try Good(f)
    catch {
      case e: Throwable if NonFatal(e) => Bad(e)
    }

  /**
   * The version number of Scalactic.
   *
   * @return the Scalactic version number.
   */
  val ScalacticVersion: String = ScalacticVersions.ScalacticVersion

  /**
   * The name org.scalactic.Chain has been deprecated and will be removed in a future version of Scalactic. Please use
   * its new name, org.scalatest.anyvals.NonEmptyList, instead.
   *
   * This type has been renamed for consistency with other 'NonEmpty' anyvals.
   */
  @deprecated("Chain has been deprecated and will be removed in a future version of Scalactic. Please use org.scalactic.anyvals.NonEmptyList instead.", "3.1.0")
  type Chain[+T] = org.scalactic.anyvals.NonEmptyList[T]

  /**
   * The name org.scalactic.Chain has been deprecated and will be removed in a future version of Scalactic. Please use
   * its new name, org.scalatest.anyvals.NonEmptyList, instead.
   *
   * This type has been renamed for consistency with other 'NonEmpty' anyvals.
   */
  @deprecated("Chain has been deprecated and will be removed in a future version of Scalactic. Please use org.scalactic.anyvals.NonEmptyList instead.", "3.1.0")
  val Chain = org.scalactic.anyvals.NonEmptyList

  /**
   * The name org.scalactic.End has been deprecated and will be removed in a future version of Scalactic. Please use
   * its new name, org.scalatest.anyvals.End, instead.
   *
   * This type has been renamed for consistency with other 'NonEmpty' anyvals.
   */
  @deprecated("End has been deprecated and will be removed in a future version of Scalactic. Please use org.scalactic.anyvals.End instead.", "3.1.0")
  val End = org.scalactic.anyvals.End
}