Class Getter<S,A>

java.lang.Object

fj.data.optic.Getter<S,A>

Type Parameters:

S - the source of a Getter

A - the target of a Getter

public abstract class Getter<S,A>
extends Object

A Getter can be seen as a glorified get method between a type S and a type A. A Getter is also a valid Fold

Constructor Summary

Constructors

Constructor	Description
Getter()

Method Summary

Modifier and Type	Method	Description
final Fold<S,A>	asFold()	view a Getter with a Fold
static <A> Getter<Either<A,A>, A>	codiagonal()
final <B> Fold<S,B>	composeFold(Fold<A,B> other)	compose a Getter with a Fold
final <B> Getter<S,B>	composeGetter(Getter<A,B> other)	compose a Getter with a Getter
final <B,C,D> Getter<S,C>	composeIso(PIso<A,B,C,D> other)	compose a Getter with a PIso
final <B,C,D> Getter<S,C>	composeLens(PLens<A,B,C,D> other)	compose a Getter with a PLens
final <B,C,D> Fold<S,C>	composeOptional(POptional<A,B,C,D> other)	compose a Getter with a POptional
final <B,C,D> Fold<S,C>	composePrism(PPrism<A,B,C,D> other)	compose a Getter with a PPrism
final <B> Getter<P2<S,B>,P2<A,B>>	first()
abstract A	get(S s)	get the target of a Getter
static <S,A> Getter<S,A>	getter(F<S,A> get)
static <A> Getter<A,A>	id()
final <S1,A1> Getter<P2<S,S1>,P2<A,A1>>	product(Getter<S1,A1> other)	pair two disjoint Getter
final <B> Getter<P2<B,S>,P2<B,A>>	second()
final <S1> Getter<Either<S,S1>, A>	sum(Getter<S1,A> other)	join two Getter with the same target

Methods inherited from class Object

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

Constructor Details

Getter

Getter()

Method Details

get

public abstract A get(S s)

get the target of a Getter

sum

public final <S1> Getter<Either<S,S1>, A> sum(Getter<S1,A> other)

join two Getter with the same target

product

public final <S1,A1> Getter<P2<S,S1>,P2<A,A1>> product(Getter<S1,A1> other)

pair two disjoint Getter

first

public final <B> Getter<P2<S,B>,P2<A,B>> first()

second

public final <B> Getter<P2<B,S>,P2<B,A>> second()

composeFold

public final <B> Fold<S,B> composeFold(Fold<A,B> other)

compose a Getter with a Fold

composeGetter

public final <B> Getter<S,B> composeGetter(Getter<A,B> other)

compose a Getter with a Getter

composeOptional

public final <B,C,D> Fold<S,C> composeOptional(POptional<A,B,C,D> other)

compose a Getter with a POptional

composePrism

public final <B,C,D> Fold<S,C> composePrism(PPrism<A,B,C,D> other)

compose a Getter with a PPrism

composeLens

public final <B,C,D> Getter<S,C> composeLens(PLens<A,B,C,D> other)

compose a Getter with a PLens

composeIso

public final <B,C,D> Getter<S,C> composeIso(PIso<A,B,C,D> other)

compose a Getter with a PIso

asFold

public final Fold<S,A> asFold()

view a Getter with a Fold

id

public static <A> Getter<A,A> id()

codiagonal

public static <A> Getter<Either<A,A>, A> codiagonal()

getter

public static <S,A> Getter<S,A> getter(F<S,A> get)