com.io7m.jfunctional.Try Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2014  http://io7m.com
 * 
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package com.io7m.jfunctional;

import com.io7m.jequality.annotations.EqualityReference;
import com.io7m.junreachable.UnreachableCodeException;

/**
 * 
 * Constructor functions for computations that can fail.
 * 
 * 
 * @see TryType
 */

@EqualityReference public final class Try
{
  /**
   * Fail trivially, yielding x.
   * 
   * @param x
   *          The result
   * @return A computation that yields x.
   * @param 
   *          The type of failure values.
   * @param 
   *          The type of success values.
   */

  public static  TryType failure(
    final F x)
  {
    return Failure.failure(x);
  }

  /**
   * Succeed trivially, yielding x.
   * 
   * @param x
   *          The result
   * @return A computation that yields x.
   * @param 
   *          The type of failure values.
   * @param 
   *          The type of success values.
   */

  public static  TryType success(
    final S x)
  {
    return Success.success(x);
  }

  private Try()
  {
    throw new UnreachableCodeException();
  }
}