Either.RightProjection (Functional Guava Extensions 2.4.0 API)

java.lang.Object
- com.atlassian.fugue.Either.RightProjection

All Implemented Interfaces:

Effect.Applicant<R>, Either.Projection<R,L,L,R>, Maybe<R>, Iterable<R>

Enclosing class:

Either<L,R>
```
public final class Either.RightProjection
extends Object
implements Either.Projection<R,L,L,R>
```
A right projection of an either value.

Method Summary

Methods
Modifier and Type	Method and Description
`<X> Either<L,X>`	`apply(Either<L,com.google.common.base.Function<R,X>> either)` Function application on this projection's value.
`Either<L,R>`	`either()` The either value underlying this projection.
`boolean`	`exists(com.google.common.base.Predicate<? super A> f)` Whether this is `is defined` and applying the predicate to the contained value returns true.
`<X> Option<Either<X,R>>`	`filter(com.google.common.base.Predicate<? super R> f)` Returns `None` if this projection has no value or if the given predicate `p` does not hold for the value, otherwise, returns a right in `Some`.
`<X,LL extends L> Either<L,X>`	`flatMap(com.google.common.base.Function<? super R,Either<LL,X>> f)` Binds the given function across this projection's value if it has one.
`boolean`	`forall(com.google.common.base.Predicate<? super A> f)` Returns `true` `if empty` or the result of the application of the given function to the value.
`void`	`foreach(Effect<? super A> f)` Perform the given side-effect for each contained element.
`R`	`get()` Get the value if defined.
`A`	`getOrElse(com.google.common.base.Supplier<? extends A> a)` Get the value `if defined` or call the supplier and return its value if not.
`<X extends A> A`	`getOrElse(X x)` Get the value if defined, otherwise returns `other`.
`A`	`getOrError(com.google.common.base.Supplier<String> err)` Get the value or throws an error with the supplied message if not defined.
`A`	`getOrNull()` Get the value if defined or null if not.
`<X extends Throwable> A`	`getOrThrow(com.google.common.base.Supplier<X> ifUndefined)` Get the value or throws the supplied throwable if not defined.
`boolean`	`isDefined()`
`boolean`	`isEmpty()`
`Iterator<A>`	`iterator()`
`<X> Either<L,X>`	`map(com.google.common.base.Function<? super R,X> f)` Map the given function across this projection's value if it has one.
`R`	`on(com.google.common.base.Function<? super L,? extends R> f)` The value of this projection or the result of the given function on the opposing projection's value.
`<X> Either<L,X>`	`sequence(Either<L,X> e)` Anonymous bind through this projection.
`Option<A>`	`toOption()` Returns this projection's value in `Some` if it exists, otherwise `None`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.fugue.Either.Projection
either, toOption

Methods inherited from interface com.atlassian.fugue.Maybe
exists, forall, getOrElse, getOrElse, getOrError, getOrNull, getOrThrow, isEmpty, iterator

Methods inherited from interface com.atlassian.fugue.Effect.Applicant
foreach

- Method Detail
  - get
```
public R get()
```
    Description copied from interface: Maybe
    
    Get the value if defined. Throw an exception otherwise.
    
    Specified by:
    
    get in interface Maybe<R>
    
    Returns:
    the wrapped value
  - isDefined
```
public boolean isDefined()
```
    Specified by:
    
    isDefined in interface Maybe<R>
    
    Returns:
    true if this holds a value, false otherwise.
  - on
```
public R on(com.google.common.base.Function<? super L,? extends R> f)
```
    Description copied from interface: Either.Projection
    
    The value of this projection or the result of the given function on the opposing projection's value.
    
    Specified by:
    
    on in interface Either.Projection<R,L,L,R>
    
    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.
  - map
```
public <X> Either<L,X> map(com.google.common.base.Function<? super R,X> f)
```
    Map the given function across this projection's value if it has one.
    
    Type Parameters:
    X - the RHS type
    Parameters:
    f - The function to map across this projection.
    
    Returns:
    A new either value after mapping.
  - flatMap
```
public <X,LL extends L> Either<L,X> flatMap(com.google.common.base.Function<? super R,Either<LL,X>> f)
```
    Binds the given function across this projection's value if it has one.
    
    Type Parameters:
    X - the RHS type
    LL - The existing LHS or a subtype
    Parameters:
    f - The function to bind across this projection.
    
    Returns:
    A new either value after binding.
  - sequence
```
public <X> Either<L,X> sequence(Either<L,X> e)
```
    Anonymous bind through this projection.
    
    Type Parameters:
    X - the RHS type
    Parameters:
    e - The value to bind with.
    
    Returns:
    An either after binding through this projection.
  - filter
```
public <X> Option<Either<X,R>> filter(com.google.common.base.Predicate<? super R> f)
```
    Returns None if this projection has no value or if the given predicate p does not hold for the value, otherwise, returns a right in Some.
    
    Type Parameters:
    X - the LHS type
    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 right in Some.
  - apply
```
public <X> Either<L,X> apply(Either<L,com.google.common.base.Function<R,X>> either)
```
    Function application on this projection's value.
    
    Type Parameters:
    X - the RHS type
    Parameters:
    either - The either of the function to apply on this projection's value.
    
    Returns:
    The result of function application within either.
  - iterator
```
public final Iterator<A> iterator()
```
    Specified by:
    
    iterator in interface Maybe<A>
    
    Specified by:
    
    iterator in interface Iterable<A>
    
    Returns:
    an iterator over the contained value if defined, or an empty one otherwise.
  - either
```
public final Either<L,R> either()
```
    Description copied from interface: Either.Projection
    
    The either value underlying this projection.
    
    Specified by:
    
    either in interface Either.Projection<A,B,L,R>
    
    Returns:
    The either value underlying this projection.
  - isEmpty
```
public final boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Maybe<A>
    
    Returns:
    true if this does not hold a value, false otherwise.
  - toOption
```
public final Option<A> toOption()
```
    Description copied from interface: Either.Projection
    
    Returns this projection's value in Some if it exists, otherwise None.
    
    Specified by:
    
    toOption in interface Either.Projection<A,B,L,R>
    
    Returns:
    This projection's value in Some if it exists, otherwise None.
  - exists
```
public final boolean exists(com.google.common.base.Predicate<? super A> f)
```
    Description copied from interface: Maybe
    
    Whether this is is defined and applying the predicate to the contained value returns true.
    
    Specified by:
    
    exists in interface Maybe<A>
    
    Parameters:
    f - the predicate to test
    
    Returns:
    true if defined and the predicate returns true for the contained value, false otherwise.
  - getOrNull
```
public final A getOrNull()
```
    Description copied from interface: Maybe
    
    Get the value if defined or null if not.
    Although the use of null is discouraged, code written to use these must often interface with code that expects and returns nulls.
    
    Specified by:
    
    getOrNull in interface Maybe<A>
    
    Returns:
    the value or null if not defined
  - forall
```
public final boolean forall(com.google.common.base.Predicate<? super A> f)
```
    Description copied from interface: Maybe
    
    Returns true if empty or the result of the application of the given function to the value.
    
    Specified by:
    
    forall in interface Maybe<A>
    
    Parameters:
    f - The predicate function to test on the contained value.
    
    Returns:
    true if no value or returns the result of the application of the given function to the value.
  - getOrError
```
public final A getOrError(com.google.common.base.Supplier<String> err)
```
    Description copied from interface: Maybe
    
    Get the value or throws an error with the supplied message if not defined.
    Used when absolutely sure this is defined.
    
    Specified by:
    
    getOrError in interface Maybe<A>
    
    Parameters:
    err - the message for the error.
    
    Returns:
    the contained value.
  - getOrThrow
```
public <X extends Throwable> A getOrThrow(com.google.common.base.Supplier<X> ifUndefined)
             throws X extends Throwable
```
    Description copied from interface: Maybe
    
    Get the value or throws the supplied throwable if not defined.
    Used when absolutely sure this is defined.
    
    Specified by:
    
    getOrThrow in interface Maybe<A>
    
    Type Parameters:
    X - the type of the Throwable that could be thrown.
    Parameters:
    ifUndefined - the supplier of the throwable.
    
    Returns:
    the contained value.
    
    Throws:
    
    X - the throwable the supplier creates if there is no value.
    
    X extends Throwable
  - getOrElse
```
public final A getOrElse(com.google.common.base.Supplier<? extends A> a)
```
    Description copied from interface: Maybe
    
    Get the value if defined or call the supplier and return its value if not.
    
    Specified by:
    
    getOrElse in interface Maybe<A>
    
    Parameters:
    a - called if this is empty
    
    Returns:
    the wrapped value or the value from the Supplier
  - getOrElse
```
public final <X extends A> A getOrElse(X x)
```
    Description copied from interface: Maybe
    
    Get the value if defined, otherwise returns other.
    
    Specified by:
    
    getOrElse in interface Maybe<A>
    
    Type Parameters:
    X - the destination type
    Parameters:
    x - value to return if this is empty
    
    Returns:
    wrapped value if this is defined, otherwise returns other
  - foreach
```
public final void foreach(Effect<? super A> f)
```
    Description copied from interface: Effect.Applicant
    
    Perform the given side-effect for each contained element.
    
    Specified by:
    
    foreach in interface Effect.Applicant<A>
    
    Parameters:
    f - the input to use for performing the effect.

Class Either.RightProjection

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.atlassian.fugue.Either.Projection

Methods inherited from interface com.atlassian.fugue.Maybe

Methods inherited from interface com.atlassian.fugue.Effect.Applicant

Method Detail

get

isDefined

on

map

flatMap

sequence

filter

apply

iterator

either

isEmpty

toOption

exists

getOrNull

forall

getOrError

getOrThrow

getOrElse

getOrElse

foreach