org.scalatest.matchers.dsl.ResultOfNotExist.scala Maven / Gradle / Ivy

/*
 * 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.dsl

import org.scalatest.enablers.Existence
import org.scalatest.matchers.Matcher
import org.scalatest.matchers.dsl.MatcherFactory1
import org.scalatest.matchers.dsl.MatcherFactory2

/**
 * 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
 * @author Chee Seng
 */
final class ResultOfNotExist(notWord: NotWord) {
  
  /**
   * This method enables the following syntax:
   *
   *    * file should (not (exist) and be (existFile))
   *                        ^
   * 
   */
  def and(anotherMatcher: Matcher[Any]): MatcherFactory1[Any, Existence] =
    notWord.exist.and(anotherMatcher)

  import scala.language.higherKinds
    
  /**
   * This method enables the following syntax:
   *
   *    * file should (not (exist) and equal (existFile))
   *                        ^
   * 
   */
  def and[TYPECLASS1[_]](anotherMatcherFactory: MatcherFactory1[Any, TYPECLASS1]): MatcherFactory2[Any, Existence, TYPECLASS1] = 
    notWord.exist.and(anotherMatcherFactory)

  /**
   * This method enables the following syntax:
   *
   *    * file should (not (exist) or be (existFile))
   *                        ^
   * 
   */
  def or(anotherMatcher: Matcher[Any]): MatcherFactory1[Any, Existence] =
    notWord.exist.or(anotherMatcher)
    
  /**
   * This method enables the following syntax:
   *
   *    * file should (not (exist) or equal (existFile))
   *                        ^
   * 
   */
  def or[TYPECLASS1[_]](anotherMatcherFactory: MatcherFactory1[Any, TYPECLASS1]): MatcherFactory2[Any, Existence, TYPECLASS1] = 
    notWord.exist.or(anotherMatcherFactory)  
    
  /**
   * Overrides toString to return "not exist"
   */
  override def toString: String = "not (exist)"
  
}