Either.RightProjection (Javaslang 2.1.0-alpha API)

java.lang.Object
- javaslang.control.Either.RightProjection<L,R>

Type Parameters:

L - The type of the Left value of an Either.

R - The type of the Right value of an Either.

All Implemented Interfaces:

Iterable<R>, Value<R>

Enclosing interface:

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

Since:

1.0.0

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<L2,R2> Either.RightProjection<L2,R2>`	`bimap(Function<? super L,? extends L2> leftMapper, Function<? super R,? extends R2> rightMapper)`
`boolean`	`equals(Object obj)` Clarifies that values have a proper equals() method implemented.
`Option<Either.RightProjection<L,R>>`	`filter(Predicate<? super R> predicate)` Returns `Some` value of type R if this is a right projection of a Right value and the predicate applies to the underlying value.
`<U> Either.RightProjection<L,U>`	`flatMap(Function<? super R,? extends Either.RightProjection<L,? extends U>> mapper)` FlatMaps this RightProjection.
`R`	`get()` Gets the Right value or throws.
`R`	`getOrElse(R other)` Gets the Right value or an alternate value, if the projected Either is a Left.
`R`	`getOrElseGet(Function<? super L,? extends R> other)` Gets the Right value or an alternate value, if the projected Either is a Left.
`<X extends Throwable> R`	`getOrElseThrow(Function<? super L,X> exceptionFunction)` Gets the Right value or throws, if the projected Either is a Left.
`int`	`hashCode()` Clarifies that values have a proper hashCode() method implemented.
`boolean`	`isEmpty()` Checks, this `Value` is empty, i.e.
`boolean`	`isSingleValued()` A `RightProjection` is single-valued.
`Iterator<R>`	`iterator()` Returns a rich `javaslang.collection.Iterator`.
`<U> Either.RightProjection<L,U>`	`map(Function<? super R,? extends U> mapper)` Maps the right value if the projected Either is a Right.
`Either.RightProjection<L,R>`	`orElse(Either.RightProjection<? extends L,? extends R> other)`
`Either.RightProjection<L,R>`	`orElse(Supplier<? extends Either.RightProjection<? extends L,? extends R>> supplier)`
`void`	`orElseRun(Consumer<? super L> action)` Runs an action in the case this is a projection on a Left value.
`Either.RightProjection<L,R>`	`peek(Consumer<? super R> action)` Applies the given action to the value if the projected either is a Right.
`String`	`stringPrefix()` Returns the name of this Value type, which is used by toString().
`Either<L,R>`	`toEither()` Returns the underlying either of this projection.
`String`	`toString()` Clarifies that values have a proper toString() method implemented.
`<U> U`	`transform(Function<? super Either.RightProjection<L,R>,? extends U> f)` Transforms this `RightProjection`.

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

Methods inherited from interface javaslang.Value
collect, collect, contains, corresponds, eq, exists, forAll, forEach, getOption, getOrElse, getOrElseThrow, getOrElseTry, narrow, out, out, stderr, stdout, toArray, toCharSeq, toEither, toEither, toInvalid, toInvalid, toJavaArray, toJavaArray, toJavaCollection, toJavaList, toJavaList, toJavaMap, toJavaMap, toJavaMap, toJavaOptional, toJavaParallelStream, toJavaSet, toJavaSet, toJavaStream, toLeft, toLeft, toLinkedMap, toLinkedMap, toLinkedSet, toList, toMap, toMap, toOption, toPriorityQueue, toPriorityQueue, toQueue, toRight, toRight, toSet, toSortedMap, toSortedMap, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toStack, toStream, toTree, toTry, toTry, toValid, toValid, toValidation, toValidation, toVector

Methods inherited from interface java.lang.Iterable
spliterator

- Method Detail
  - bimap
```
public <L2,R2> Either.RightProjection<L2,R2> bimap(Function<? super L,? extends L2> leftMapper,
                                                   Function<? super R,? extends R2> rightMapper)
```
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: Value
    
    Checks, this Value is empty, i.e. if the underlying value is absent.
    
    Specified by:
    
    isEmpty in interface Value<R>
    
    Returns:
    
    false, if no underlying value is present, true otherwise.
  - isSingleValued
```
public boolean isSingleValued()
```
    A RightProjection is single-valued.
    
    Specified by:
    
    isSingleValued in interface Value<R>
    
    Returns:
    
    true
  - get
```
public R get()
```
    Gets the Right value or throws.
    
    Specified by:
    
    get in interface Value<R>
    
    Returns:
    
    the left value, if the underlying Either is a Right
    
    Throws:
    
    NoSuchElementException - if the underlying either of this RightProjection is a Left
  - orElse
```
public Either.RightProjection<L,R> orElse(Either.RightProjection<? extends L,? extends R> other)
```
  - orElse
```
public Either.RightProjection<L,R> orElse(Supplier<? extends Either.RightProjection<? extends L,? extends R>> supplier)
```
  - getOrElse
```
public R getOrElse(R other)
```
    Gets the Right value or an alternate value, if the projected Either is a Left.
    
    Specified by:
    
    getOrElse in interface Value<R>
    
    Parameters:
    
    other - an alternative value
    
    Returns:
    
    the right value, if the underlying Either is a Right or else other
    
    Throws:
    
    NoSuchElementException - if the underlying either of this RightProjection is a Left
  - getOrElseGet
```
public R getOrElseGet(Function<? super L,? extends R> other)
```
    Gets the Right value or an alternate value, if the projected Either is a Left.
    
    Parameters:
    
    other - a function which converts a Left value to an alternative Right value
    
    Returns:
    
    the right value, if the underlying Either is a Right or else the alternative Right value provided by other by applying the Left value.
  - orElseRun
```
public void orElseRun(Consumer<? super L> action)
```
    Runs an action in the case this is a projection on a Left value.
    
    Parameters:
    
    action - an action which consumes a Left value
  - getOrElseThrow
```
public <X extends Throwable> R getOrElseThrow(Function<? super L,X> exceptionFunction)
                                       throws X extends Throwable
```
    Gets the Right value or throws, if the projected Either is a Left.
    
    Type Parameters:
    
    X - a throwable type
    
    Parameters:
    
    exceptionFunction - a function which creates an exception based on a Left value
    
    Returns:
    
    the right value, if the underlying Either is a Right or else throws the exception provided by exceptionFunction by applying the Left value.
    
    Throws:
    
    X - if the projected Either is a Left
    
    X extends Throwable
  - toEither
```
public Either<L,R> toEither()
```
    Returns the underlying either of this projection.
    
    Returns:
    
    the underlying either
  - filter
```
public Option<Either.RightProjection<L,R>> filter(Predicate<? super R> predicate)
```
    Returns Some value of type R if this is a right projection of a Right value and the predicate applies to the underlying value.
    
    Parameters:
    
    predicate - A predicate
    
    Returns:
    
    A new Option
  - flatMap
```
public <U> Either.RightProjection<L,U> flatMap(Function<? super R,? extends Either.RightProjection<L,? extends U>> mapper)
```
    FlatMaps this RightProjection.
    
    Type Parameters:
    
    U - Component type of the mapped right value
    
    Parameters:
    
    mapper - A mapper
    
    Returns:
    
    this as RightProjection<L, U> if a Left is underlying, otherwise a the mapping result of the right value.
    
    Throws:
    
    NullPointerException - if mapper is null
  - map
```
public <U> Either.RightProjection<L,U> map(Function<? super R,? extends U> mapper)
```
    Maps the right value if the projected Either is a Right.
    
    Specified by:
    
    map in interface Value<R>
    
    Type Parameters:
    
    U - The new type of a Right value
    
    Parameters:
    
    mapper - A mapper which takes a right value and returns a value of type U
    
    Returns:
    
    A new RightProjection
  - peek
```
public Either.RightProjection<L,R> peek(Consumer<? super R> action)
```
    Applies the given action to the value if the projected either is a Right. Otherwise nothing happens.
    
    Specified by:
    
    peek in interface Value<R>
    
    Parameters:
    
    action - An action which takes a right value
    
    Returns:
    
    this Either instance
  - transform
```
public <U> U transform(Function<? super Either.RightProjection<L,R>,? extends U> f)
```
    Transforms this RightProjection.
    
    Type Parameters:
    
    U - Type of transformation result
    
    Parameters:
    
    f - A transformation
    
    Returns:
    
    An instance of type U
    
    Throws:
    
    NullPointerException - if f is null
  - iterator
```
public Iterator<R> iterator()
```
    Description copied from interface: Value
    
    Returns a rich javaslang.collection.Iterator.
    
    Specified by:
    
    iterator in interface Iterable<R>
    
    Specified by:
    
    iterator in interface Value<R>
    
    Returns:
    
    A new Iterator
  - equals
```
public boolean equals(Object obj)
```
    Description copied from interface: Value
    
    Clarifies that values have a proper equals() method implemented.
    See Object.equals(Object).
    
    Specified by:
    
    equals in interface Value<R>
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - An object
    
    Returns:
    
    true, if this equals o, false otherwise
  - hashCode
```
public int hashCode()
```
    Description copied from interface: Value
    
    Clarifies that values have a proper hashCode() method implemented.
    See Object.hashCode().
    
    Specified by:
    
    hashCode in interface Value<R>
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    The hashcode of this object
  - stringPrefix
```
public String stringPrefix()
```
    Description copied from interface: Value
    
    Returns the name of this Value type, which is used by toString().
    
    Specified by:
    
    stringPrefix in interface Value<R>
    
    Returns:
    
    This type name.
  - toString
```
public String toString()
```
    Description copied from interface: Value
    
    Clarifies that values have a proper toString() method implemented.
    See Object.toString().
    
    Specified by:
    
    toString in interface Value<R>
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A String representation of this object

Class Either.RightProjection<L,R>

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface javaslang.Value

Methods inherited from interface java.lang.Iterable

Method Detail

bimap

isEmpty

isSingleValued

get

orElse

orElse

getOrElse

getOrElseGet

orElseRun

getOrElseThrow

toEither

filter

flatMap

map

peek

transform

iterator

equals

hashCode

stringPrefix

toString