fj.data

Class Either.RightProjection<A,B>

java.lang.Object

fj.data.Either.RightProjection<A,B>

All Implemented Interfaces:

java.lang.Iterable<B>

Enclosing class:

Either<A,B>

public final class Either.RightProjection<A,B>
extends java.lang.Object
implements java.lang.Iterable<B>

A right projection of an either value.

Method Summary

Methods

Modifier and Type	Method and Description
<X> Either<A,X>	apply(Either<A,F<B,X>> e) Function application on this projection's value.
<X> Either<A,X>	bind(F<B,Either<A,X>> f) Binds the given function across this projection's value if it has one.
Either<A,B>	either() The either value underlying this projection.
boolean	exists(F<B,java.lang.Boolean> f) Returns false if no value or returns the result of the application of the given function to the value.
<X> Option<Either<X,B>>	filter(F<B,java.lang.Boolean> f) Returns None if this projection has no value or if the given predicate p does not hold for the value, otherwise, returns a left in Some.
boolean	forall(F<B,java.lang.Boolean> f) Returns true if no value or returns the result of the application of the given function to the value.
void	foreach(Effect<B> f) Execute a side-effect on this projection's value if it has one.
Unit	foreach(F<B,Unit> f) Execute a side-effect on this projection's value if it has one.
java.util.Iterator<B>	iterator() Returns an iterator for this projection.
<X> Either<A,X>	map(F<B,X> f) Map the given function across this projection's value if it has one.
B	on(F<A,B> f) The value of this projection or the result of the given function on the opposing projection's value.
B	orValue(P1<B> b) The value of this projection or the given argument.
<X> Either<A,X>	sequence(Either<A,X> e) Anonymous bind through this projection.
Array<B>	toArray() Returns a single element array if this projection has a value, otherwise an empty array.
java.util.Collection<B>	toCollection() Projects an immutable collection of this projection.
List<B>	toList() Returns a single element list if this projection has a value, otherwise an empty list.
Option<B>	toOption() Returns this projection's value in Some if it exists, otherwise None.
Stream<B>	toStream() Returns a single element stream if this projection has a value, otherwise an empty stream.
B	value() The value of this projection or fails with a specialised error message.
B	valueE(P1<java.lang.String> err) Returns the value of this projection or fails with the given error message.

Methods inherited from class java.lang.Object

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

Method Detail

iterator

public java.util.Iterator<B> iterator()

Returns an iterator for this projection. This method exists to permit the use in a for-each loop.

Specified by:

iterator in interface java.lang.Iterable<B>

Returns:

A iterator for this projection.

either

public Either<A,B> either()

The either value underlying this projection.

Returns:

The either value underlying this projection.

valueE

public B valueE(P1<java.lang.String> err)

Returns the value of this projection or fails with the given error message.

Parameters:

err - The error message to fail with.

Returns:

The value of this projection

value

public B value()

The value of this projection or fails with a specialised error message.

Returns:

The value of this projection.

orValue

public B orValue(P1<B> b)

The value of this projection or the given argument.

Parameters:

b - The value to return if this projection has no value.

Returns:

The value of this projection or the given argument.

on

public B on(F<A,B> f)

The value of this projection or the result of the given function on the opposing projection's value.

Parameters:

f - The function to execute if this projection has no value.

Returns:

The value of this projection or the result of the given function on the opposing projection's value.

foreach

public Unit foreach(F<B,Unit> f)

Execute a side-effect on this projection's value if it has one.

Parameters:

f - The side-effect to execute.

Returns:

The unit value.

foreach

public void foreach(Effect<B> f)

Execute a side-effect on this projection's value if it has one.

Parameters:

f - The side-effect to execute.

map

public <X> Either<A,X> map(F<B,X> f)

Map the given function across this projection's value if it has one.

Parameters:

f - The function to map across this projection.

Returns:

A new either value after mapping.

bind

public <X> Either<A,X> bind(F<B,Either<A,X>> f)

Binds the given function across this projection's value if it has one.

Parameters:

f - The function to bind across this projection.

Returns:

A new either value after binding.

sequence

public <X> Either<A,X> sequence(Either<A,X> e)

Anonymous bind through this projection.

Parameters:

e - The value to bind with.

Returns:

An either after binding through this projection.

filter

public <X> Option<Either<X,B>> filter(F<B,java.lang.Boolean> f)

Returns None if this projection has no value or if the given predicate p does not hold for the value, otherwise, returns a left in Some.

Parameters:

f - The predicate function to test on this projection's value.

Returns:

None if this projection has no value or if the given predicate p does not hold for the value, otherwise, returns a left in Some.

apply

public <X> Either<A,X> apply(Either<A,F<B,X>> e)

Function application on this projection's value.

Parameters:

e - The either of the function to apply on this projection's value.

Returns:

The result of function application within either.

forall

public boolean forall(F<B,java.lang.Boolean> f)

Returns true if no value or returns the result of the application of the given function to the value.

Parameters:

f - The predicate function to test on this projection's value.

Returns:

true if no value or returns the result of the application of the given function to the value.

exists

public boolean exists(F<B,java.lang.Boolean> f)

Returns false if no value or returns the result of the application of the given function to the value.

Parameters:

f - The predicate function to test on this projection's value.

Returns:

false if no value or returns the result of the application of the given function to the value.

toList

public List<B> toList()

Returns a single element list if this projection has a value, otherwise an empty list.

Returns:

A single element list if this projection has a value, otherwise an empty list.

toOption

public Option<B> toOption()

Returns this projection's value in Some if it exists, otherwise None.

Returns:

This projection's value in Some if it exists, otherwise None.

toArray

public Array<B> toArray()

Returns a single element array if this projection has a value, otherwise an empty array.

Returns:

A single element array if this projection has a value, otherwise an empty array.

toStream

public Stream<B> toStream()

Returns a single element stream if this projection has a value, otherwise an empty stream.

Returns:

A single element stream if this projection has a value, otherwise an empty stream.

toCollection

public java.util.Collection<B> toCollection()

Projects an immutable collection of this projection.

Returns:

An immutable collection of this projection.