com.io7m.jfunctional

Class Failure<F,S>

java.lang.Object

com.io7m.jfunctional.Failure<F,S>

Type Parameters:

F - The type of values returned upon failure.

S - The type of values returned upon success.

All Implemented Interfaces:

TryType<F,S>, Serializable

@EqualityStructural
public final class Failure<F,S>
extends Object
implements TryType<F,S>

A computation that has failed.

See Also:

TryType, Serialized Form

Method Summary

Modifier and Type	Method and Description
<U> U	accept(TryVisitorType<F,S,U> v) Accept a visitor.
<U,E extends Throwable> U	acceptPartial(TryPartialVisitorType<F,S,U,E> v) Accept a partial visitor.
boolean	equals(Object obj)
static <F,S> Failure<F,S>	failure(F x) Produce a new failure value.
F	get()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

failure

public static <F,S> Failure<F,S> failure(F x)

Produce a new failure value.

Type Parameters:

F - The type of values returned upon failure.

S - The type of values returned upon success.

Parameters:

x - The actual value

Returns:

A new failure value

Since:

1.3.0

accept

public <U> U accept(TryVisitorType<F,S,U> v)

Description copied from interface: TryType

Accept a visitor.

Specified by:

accept in interface TryType<F,S>

Type Parameters:

U - The type of values returned by the visitor.

Parameters:

v - The visitor

Returns:

The value returned by the visitor.

acceptPartial

public <U,E extends Throwable> U acceptPartial(TryPartialVisitorType<F,S,U,E> v)
                                        throws E extends Throwable

Description copied from interface: TryType

Accept a partial visitor.

Specified by:

acceptPartial in interface TryType<F,S>

Type Parameters:

U - The type of values returned by the visitor.

E - The type of exceptions thrown by the visitor.

Parameters:

v - The visitor

Returns:

The value returned by the visitor.

Throws:

E - If the visitor throws E.

E extends Throwable

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

get

public F get()

Returns:

The value contained within.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object