com.github.javactic.Fail Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javactic Show documentation
A Java port of Scalactic
There is a newer version: 2.1.0
package com.github.javactic;
/*
 *    ___                       _   _
 *   |_  |                     | | (_)
 *     | | __ ___   ____ _  ___| |_ _  ___
 *     | |/ _` \ \ / / _` |/ __| __| |/ __|
 * /\__/ / (_| |\ V / (_| | (__| |_| | (__   -2015-
 * \____/ \__,_| \_/ \__,_|\___|\__|_|\___|
 *
 * 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.
 */

import java.io.Serializable;

/**
 * Indicates a validation failed, describing the failure with a contained error value.
 *
 * @author mvh
 *
 * @param  the type of value describing a validation failure for this Fail
 */
public final class Fail implements Validation, Serializable {

  private static final long serialVersionUID = 1L;

  private final T error;

  public static  Fail of(T error) {
    return new Fail<>(error);
  }

  public static Fail ofString(String error, Object... args) {
    return new Fail<>(Helper.parse(error, args));
  }

  Fail(T error) {
    this.error = error;
  }

  @Override
  public Validation and(Validation other) {
    return this;
  }

  @Override
  public boolean isPass() {
    return false;
  }

  @Override
  public boolean isFail() {
    return true;
  }

  @Override
  public T getError() {
    return error;
  }

  @Override
  public String toString() {
    return "Fail(" + error + ")";
  }

  @Override
  public int hashCode() {
    final int prime = 31;
    int result = 1;
    result = prime * result + ((error == null) ? 0 : error.hashCode());
    return result;
  }

  @Override
  public boolean equals(Object obj) {
    if (this == obj)
      return true;
    if (obj == null)
      return false;
    if (getClass() != obj.getClass())
      return false;
    @SuppressWarnings("rawtypes")
    Fail other = (Fail) obj;
    if (error == null) {
      if (other.error != null)
        return false;
    } else if (!error.equals(other.error))
      return false;
    return true;
  }
}