com.io7m.jfunctional.Success 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.EqualityStructural;
import com.io7m.jnull.NullCheck;
import com.io7m.jnull.Nullable;

/**
 * 
 * A computation that has succeeded.
 * 
 * 
 * @see TryType
 * @param 
 *          The type of values returned upon failure.
 * @param 
 *          The type of values returned upon success.
 */

@EqualityStructural public final class Success implements TryType
{
  private static final long serialVersionUID = 1087956509094272540L;

  static  Success success(
    final S x)
  {
    return new Success(x);
  }

  private final S x;

  private Success(
    final S in_x)
  {
    this.x = NullCheck.notNull(in_x, "Success value");
  }

  @Override public  U accept(
    final TryVisitorType v)
  {
    NullCheck.notNull(v, "Visitor");
    return v.success(this);
  }

  @Override public  U acceptPartial(
    final TryPartialVisitorType v)
    throws E
  {
    NullCheck.notNull(v, "Visitor");
    return v.success(this);
  }

  @Override public boolean equals(
    final @Nullable Object obj)
  {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (this.getClass() != obj.getClass()) {
      return false;
    }
    final Success other = (Success) obj;
    return this.x.equals(other.x);
  }

  /**
   * @return The value contained within.
   */

  public S get()
  {
    return this.x;
  }

  @Override public int hashCode()
  {
    return this.x.hashCode();
  }

  @Override public String toString()
  {
    final StringBuilder builder = new StringBuilder();
    builder.append("[Success ");
    builder.append(this.x);
    builder.append("]");
    final String s = builder.toString();
    assert s != null;
    return s;
  }
}