javascalautils

Class Success<T>

java.lang.Object

javascalautils.Success<T>

Type Parameters:

T - The type of the value represented by this instance

All Implemented Interfaces:

Serializable, Iterable<T>, Try<T>

public final class Success<T>
extends Object
implements Try<T>, Serializable

Represents the 'successful' implementation of Try.
For examples on usage refer to the documentation for Try.

Since:

1.0

Author:

Peter Nerg

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Success(T value) Creates a 'successful' instance with the provided value.

Method Summary

Modifier and Type	Method and Description
Try<Throwable>	failed() Returns a Failure with an UnsupportedOperationException.
<R> Try<R>	flatMap(java.util.function.Function<T,Try<R>> function) Applies the value to the function and returns the Try generated by the function..
T	get() Returns the value provided in the constructor.
T	getOrElse(java.util.function.Supplier<T> supplier) Returns the value provided in the constructor.
boolean	isSuccess() Always returns true.
<R> Try<R>	map(java.util.function.Function<T,R> function) Applies the value to the function and returns the Try representing the mapped value.
Try<T>	orElse(java.util.function.Supplier<Try<T>> supplier) Always returns this.
String	toString() Returns a String representation of the instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javascalautils.Try

apply, apply, asOption, isFailure, iterator, orNull, stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Success

public Success(T value)

Creates a 'successful' instance with the provided value.
Null values are allowed.

Parameters:

value - The value represented by this instance

Method Detail

isSuccess

public boolean isSuccess()

Always returns true.

Specified by:

isSuccess in interface Try<T>

Returns:

If the Try is a Success

getOrElse

public T getOrElse(java.util.function.Supplier<T> supplier)

Returns the value provided in the constructor.
I.e. the provided supplier is never use.

Specified by:

getOrElse in interface Try<T>

Parameters:

supplier - The supplier to return the value in case of a Failure

Returns:

The value from the Try or the supplier

orElse

public Try<T> orElse(java.util.function.Supplier<Try<T>> supplier)

Always returns this.
I.e. the provided supplier is never use.

Specified by:

orElse in interface Try<T>

Parameters:

supplier - The supplier to return the value in case of a Failure

Returns:

This try or the value from the supplier

get

public T get()

Returns the value provided in the constructor.

Specified by:

get in interface Try<T>

Returns:

The value of the Success

failed

public Try<Throwable> failed()

Returns a Failure with an UnsupportedOperationException.
Since this is a 'success' it cannot be mapped to a 'failure'

Specified by:

failed in interface Try<T>

Returns:

The value of the Failure in a Success

map

public <R> Try<R> map(java.util.function.Function<T,R> function)

Applies the value to the function and returns the Try representing the mapped value.

Specified by:

map in interface Try<T>

Type Parameters:

R - The type for the return value from the function

Parameters:

function - The function to use

Returns:

The Option containing the mapped value

flatMap

public <R> Try<R> flatMap(java.util.function.Function<T,Try<R>> function)

Applies the value to the function and returns the Try generated by the function..

Specified by:

flatMap in interface Try<T>

Type Parameters:

R - The type for the return value from the function

Parameters:

function - The function to use

Returns:

The Option containing the mapped value

toString

public String toString()

Returns a String representation of the instance.

Overrides:

toString in class Object