Index (Functional Extensions 4.7.2 API)

A B C D E F G H I J L M N O P R S T U V W Z

A

accept(A) - Method in interface io.atlassian.fugue.Effect: Deprecated.

Adapt to the Java 8 interface.
addAll(Collection<A>, Iterable<? extends A>) - Static method in class io.atlassian.fugue.Iterables: Add all the elements of the iterable to the collection
all(Iterable<? extends A>, Predicate<? super A>) - Static method in class io.atlassian.fugue.Iterables: Check if all elements in the input iterable match the input predicate
alwaysFalse() - Static method in class io.atlassian.fugue.Suppliers: Supplies false.
alwaysNull() - Static method in class io.atlassian.fugue.Suppliers: Always returns null.
alwaysTrue() - Static method in class io.atlassian.fugue.Suppliers: Supplies true.
any(Iterable<? extends A>, Predicate<? super A>) - Static method in class io.atlassian.fugue.Iterables: Check if the iterable contains any elements that match the predicate.
ap(Either<L, Function<R, X>>) - Method in class io.atlassian.fugue.Either: Function application on this projection's value.
ap(Either<Function<L, X>, R>) - Method in class io.atlassian.fugue.Either.LeftProjection: Function application on this projection's value.
ap(Either<L, Function<R, X>>) - Method in class io.atlassian.fugue.Either.RightProjection: Function application on this projection's value.
ap(Function<C, A>, Function<C, Function<A, B>>) - Static method in class io.atlassian.fugue.Functions: Performs function application within a higher-order function (applicative functor pattern).
ap(Iterable<A>, Iterable<Function<A, B>>) - Static method in class io.atlassian.fugue.Iterables: Performs function application within an iterable (applicative functor pattern).
ap(Option<A>, Option<Function<A, B>>) - Static method in class io.atlassian.fugue.Options: Applies an option of A to an option of a function with input type A and result type B and return an option of B.
ap(Pair<A, A>, Pair<Function<A, B>, Function<A, B>>) - Static method in class io.atlassian.fugue.Pair: Performs function application within an homogeneous pair (applicative functor pattern).
ap(Supplier<A>, Supplier<Function<A, B>>) - Static method in class io.atlassian.fugue.Suppliers: Performs function application within a supplier (applicative functor pattern).
append(A, A) - Method in interface io.atlassian.fugue.Semigroup: Combine the two given arguments.
Applicant<A> - Interface in io.atlassian.fugue: A thing upon which side-effects may be applied.
apply(A) - Method in interface io.atlassian.fugue.Checked.Function
apply(A) - Method in interface io.atlassian.fugue.Effect: Deprecated.

Perform the side-effect.
apply(Either<L, Function<R, X>>) - Method in class io.atlassian.fugue.Either: Deprecated.
since 3.0 see Either.ap(io.atlassian.fugue.Either<L, java.util.function.Function<R, X>>)
apply(Either<Function<L, X>, R>) - Method in class io.atlassian.fugue.Either.LeftProjection: Deprecated.
since 3.0
apply(Either<L, Function<R, X>>) - Method in class io.atlassian.fugue.Either.RightProjection: Deprecated.
since 3.0 see ap
apply(A) - Static method in class io.atlassian.fugue.Functions: Function that takes another function and applies it to the argument.
apply(Supplier<A>) - Static method in class io.atlassian.fugue.Functions: Function that takes another function and applies it to the argument supplied by the parameter.
attempt() - Method in interface io.atlassian.fugue.Checked.Supplier

B

bigDecimalMaximum - Static variable in class io.atlassian.fugue.Semigroups: A semigroup that yields the maximum of big decimals.
bigDecimalMinimum - Static variable in class io.atlassian.fugue.Semigroups: A semigroup that yields the minimum of big decimals.
bigintAddition - Static variable in class io.atlassian.fugue.Monoids: A monoid that adds big integers.
bigintMaximum - Static variable in class io.atlassian.fugue.Semigroups: A semigroup that yields the maximum of big integers.
bigintMinimum - Static variable in class io.atlassian.fugue.Semigroups: A semigroup that yields the minimum of big integers.
bigintMultiplication - Static variable in class io.atlassian.fugue.Monoids: A monoid that multiplies big integers.
bimap(Function<? super L, ? extends LL>, Function<? super R, ? extends RR>) - Method in class io.atlassian.fugue.Either: Map the given functions across the appropriate side.

C

Checked - Class in io.atlassian.fugue: Helpers to work with functions that may throw exceptions.
Checked.Function<A,B,E extends Exception> - Interface in io.atlassian.fugue: Represents a Checked.Function that may throw an exception.
Checked.Supplier<A,E extends Exception> - Interface in io.atlassian.fugue: Represents a Checked.Supplier that may throw an exception.
collect(Iterable<? extends A>, Function<? super A, Option>) - Static method in class io.atlassian.fugue.Iterables: Filters and maps (aka transforms) the unfiltered iterable.
collect(Iterable<T>, Collector<T, A, R>) - Static method in class io.atlassian.fugue.Iterables: Uses a Collector to collect/reduce an Iterable.
compose(Function<? super B, ? extends C>, Function<? super A, ? extends B>) - Static method in class io.atlassian.fugue.Functions: Returns the composition of two functions.
compose(Monoid<A>, Monoid) - Static method in interface io.atlassian.fugue.Monoid: Composes a monoid with another.
compose(Semigroup<A>, Semigroup) - Static method in interface io.atlassian.fugue.Semigroup: Composes a semigroup with another.
compose(Function<? super A, B>, Supplier<A>) - Static method in class io.atlassian.fugue.Suppliers: Create a new Supplier by transforming the result calling the first Supplier
composeOption(Function<? super B, ? extends Option<? extends C>>, Function<? super A, ? extends Option<? extends B>>) - Static method in class io.atlassian.fugue.Functions: Compose two PartialFunctions into one.
concat(Iterable<? extends A>...) - Static method in class io.atlassian.fugue.Iterables: Concatenate a series of iterables into a single iterable.
cond(boolean, L, R) - Static method in class io.atlassian.fugue.Eithers: Creates an Either based on a boolean expression.
conjunction - Static variable in class io.atlassian.fugue.Monoids: A monoid that ANDs booleans.
constant(B) - Static method in class io.atlassian.fugue.Functions: Create a function ignores it's input an produces a constant value
curried(BiFunction<A, B, C>) - Static method in class io.atlassian.fugue.Functions: Transforms a function that takes 2 arguments into a function that takes the first argument and return a new function that takes the second argument and return the final result.
cycle(A...) - Static method in class io.atlassian.fugue.Iterables: Return an infinite iterable that cycles through the input values in order in a loop.
cycle(Iterable<? extends A>) - Static method in class io.atlassian.fugue.Iterables: Return an infinite iterable that cycles through the input values in order in a loop.

D

defined() - Static method in class io.atlassian.fugue.Option: Predicate for filtering defined options only.
delay(Checked.Supplier<A, E>) - Static method in class io.atlassian.fugue.Checked: Create a new delayed Try representing a delayed evaluation of a potentially exception throwing operation.
delayed(Supplier<Try<A>>) - Static method in class io.atlassian.fugue.Try: Creates a delayed Try, which will return either a Failure or a Success when evaluated.
delayedLift(Checked.Function<A, B, E>) - Static method in class io.atlassian.fugue.Checked: Lifts a function that potentially throws into a function that either returns a delayed Try, which, when evaluated, returns a Success of the result or a failure containing the thrown exception.
disjunction - Static variable in class io.atlassian.fugue.Monoids: A monoid that ORs booleans.
drop(int, Iterable<A>) - Static method in class io.atlassian.fugue.Iterables: Drop the first n as and return the rest.
dropWhile(Iterable<A>, Predicate<A>) - Static method in class io.atlassian.fugue.Iterables: Drop elements of as until an element returns false for p#test
dual(Monoid<A>) - Static method in interface io.atlassian.fugue.Monoid: Return the dual Monoid.
dual(Semigroup<A>) - Static method in interface io.atlassian.fugue.Semigroup: Return the dual Semigroup of a semigroup

E

Effect<A> - Interface in io.atlassian.fugue: Deprecated.
in favour of Consumer
Effect.Applicant<A> - Interface in io.atlassian.fugue: Deprecated.
in favour of Iterable
Either<L,R> - Class in io.atlassian.fugue: A class that acts as a container for a value of one of two types.
either() - Method in interface io.atlassian.fugue.Either.Projection: The either value underlying this projection.
either(Semigroup<L>, Monoid<R>) - Static method in class io.atlassian.fugue.Monoids: A monoid Sums up values inside either Semigroups.either(io.atlassian.fugue.Semigroup<L>, io.atlassian.fugue.Semigroup<R>).
either(Semigroup<L>, Semigroup<R>) - Static method in class io.atlassian.fugue.Semigroups: Sums up values inside either, if both are left or right.
Either.LeftProjection - Class in io.atlassian.fugue: A left projection of an either value.
Either.Projection<A,B,L,R> - Interface in io.atlassian.fugue
Either.RightProjection - Class in io.atlassian.fugue: A right projection of an either value.
Eithers - Class in io.atlassian.fugue: Utility functions for Eithers.
emptyIterable() - Static method in class io.atlassian.fugue.Iterables: Returns an empty iterable, that is, an Iterable with an Iterator for which hasNext() always returns false, and the other methods throw appropriate exceptions if called.
equals(Object) - Method in class io.atlassian.fugue.Option
equals(Object) - Method in class io.atlassian.fugue.Pair
exclusiveDisjunction - Static variable in class io.atlassian.fugue.Monoids: A monoid that XORs booleans.
exists(Predicate<? super R>) - Method in class io.atlassian.fugue.Either: Return `true` if this is a right value and applying the predicate to the contained value returns true.
exists(Predicate<? super A>) - Method in interface io.atlassian.fugue.Maybe: Whether this is is defined and applying the predicate to the contained value returns true.
exists(Predicate<? super A>) - Method in class io.atlassian.fugue.Option: Whether this is is defined and applying the predicate to the contained value returns true.

F

failure(Exception) - Static method in class io.atlassian.fugue.Try: Creates a new failure
filter(Predicate<? super R>) - Method in class io.atlassian.fugue.Either: Returns None if this is a left or if the given predicate p does not hold for the contained value, otherwise, returns a right in Some.
filter(Predicate<? super L>) - Method in class io.atlassian.fugue.Either.LeftProjection: 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.
filter(Predicate<? super R>) - Method in class io.atlassian.fugue.Either.RightProjection: 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.
filter(Iterable<A>, Predicate<? super A>) - Static method in class io.atlassian.fugue.Iterables: Remove elements from the input iterable for which the predicate returns false
filter(Predicate<? super A>) - Method in class io.atlassian.fugue.Option: Returns this Option if it is nonempty and applying the predicate to this option's value returns true.
filterLeft(Iterable<Either<L, R>>) - Static method in class io.atlassian.fugue.Eithers: Takes an Iterable of eithers, and collects the left values of every either which has a left value
filterNone(Iterable<Option<A>>) - Static method in class io.atlassian.fugue.Options: Filter out undefined options.
filterOrElse(Predicate<? super R>, Supplier<? extends L>) - Method in class io.atlassian.fugue.Either: Return a Right if this is a Right and the contained values satisfies the given predicate.
filterOrElse(Predicate<? super L>, Supplier<? extends R>) - Method in class io.atlassian.fugue.Either.LeftProjection: Return a Left if this is a Left and the contained values satisfies the given predicate.
filterOrElse(Predicate<? super R>, Supplier<? extends L>) - Method in class io.atlassian.fugue.Either.RightProjection: Return a Right if this is a Right and the contained values satisfies the given predicate.
filterOrElse(Predicate<? super A>, Supplier<Exception>) - Method in class io.atlassian.fugue.Try: Return a Success if this is a Success and the contained values satisfies the given predicate.
filterRight(Iterable<Either<L, R>>) - Static method in class io.atlassian.fugue.Eithers: Takes an Iterable of eithers, and collects the right values of every either which has a left value
find(Iterable<Option<A>>) - Static method in class io.atlassian.fugue.Options: Find the first option that isDefined, or if there aren't any, then none.
findFirst(Iterable<? extends T>, Predicate<? super T>) - Static method in class io.atlassian.fugue.Iterables: Finds the first item that matches the predicate.
findFirst(Predicate<? super A>) - Static method in class io.atlassian.fugue.Iterables: Partial application of the predicate argument to Iterables.findFirst(Iterable, Predicate) returning a function that takes an Iterable as its argument
first(Iterable<A>) - Static method in class io.atlassian.fugue.Iterables: If as is empty, returns none().
first() - Static method in class io.atlassian.fugue.Semigroups: Return the first value, ignore the second
firstOption() - Static method in class io.atlassian.fugue.Monoids: A monoid for options (that take the first available value).
flatMap(Function<? super R, Either<LL, X>>) - Method in class io.atlassian.fugue.Either: Binds the given function across the right hand side value if it is one.
flatMap(Function<? super L, Either<X, RR>>) - Method in class io.atlassian.fugue.Either.LeftProjection: Binds the given function across this projection's value if it has one.
flatMap(Function<? super R, Either<LL, X>>) - Method in class io.atlassian.fugue.Either.RightProjection: Binds the given function across this projection's value if it has one.
flatMap(Iterable<A>, Function<? super A, ? extends Iterable<? extends B>>) - Static method in class io.atlassian.fugue.Iterables: Applies f to each element of collection, then concatenates the result.
flatMap(Function<? super A, ? extends Option<? extends B>>) - Method in class io.atlassian.fugue.Option: Apply f to the value if defined.
flatMap(Function<? super A, Try>) - Method in class io.atlassian.fugue.Try: Binds the given function across the success value if it is one.
flatten() - Static method in class io.atlassian.fugue.FugueCollectors: Collect the values wrapped within the option.
flatten(Collector<A, B, C>) - Static method in class io.atlassian.fugue.FugueCollectors: Collect the values wrapped within the option.
flatten(Iterable<Option<A>>) - Static method in class io.atlassian.fugue.Options: Flattens an Iterable of options into an iterable of the things, filtering out any nones.
flatten(Try<Try<A>>) - Static method in class io.atlassian.fugue.Try: Reduces a nested Try by a single level
flip(Function<A, Function<B, C>>) - Static method in class io.atlassian.fugue.Functions: Transforms a function from A -> (B -> C) into a function from B -> (A -> C).
fold(Function<? super L, V>, Function<? super R, V>) - Method in class io.atlassian.fugue.Either: Applies the function to the wrapped value, applying ifLeft if this is a Left and ifRight if this is a Right.
fold(BiFunction<? super T, F, T>, T, Iterable<? extends F>) - Static method in class io.atlassian.fugue.Functions: Apply f to each element in elements, with each application using the result of the previous application as the other argument to f.
fold(Function<Pair<S, F>, T>, T, Iterable<? extends F>) - Static method in class io.atlassian.fugue.Functions: Apply f to each element in elements, with each application using the result of the previous application as the other argument to f.
fold(Supplier<? extends B>, Function<? super A, ? extends B>) - Method in class io.atlassian.fugue.Option: If this is a some value apply the some function, otherwise get the None value.
fold(Function<? super Exception, B>, Function<A, B>) - Method in class io.atlassian.fugue.Try: Applies the function to the wrapped value, applying failureF it this is a Failure and successF if this is a Success.
forall(Predicate<? super R>) - Method in class io.atlassian.fugue.Either: Returns true if it is a left or the result of the application of the given predicate on the contained value.
forall(Predicate<? super A>) - Method in interface io.atlassian.fugue.Maybe: Returns true if empty or the result of the application of the given function to the value.
forall(Predicate<? super A>) - Method in class io.atlassian.fugue.Option: Returns true if empty or the result of the application of the given function to the value.
forEach(Consumer<? super A>) - Method in interface io.atlassian.fugue.Applicant: Perform the given Consumer (side-effect) for each contained element.
foreach(Effect<? super A>) - Method in interface io.atlassian.fugue.Effect.Applicant: Deprecated.
extend or implement Iterable.forEach(Consumer) instead
foreach(Effect<? super R>) - Method in class io.atlassian.fugue.Either: Deprecated.
use Either.forEach(Consumer) instead
forEach(Consumer<? super R>) - Method in class io.atlassian.fugue.Either: Perform the given side-effect for the contained element if it is a right
forEach(Consumer<? super A>) - Method in class io.atlassian.fugue.Try: Perform the given Consumer (side-effect) for the success if success value.
forMap(Map<A, B>) - Static method in class io.atlassian.fugue.Functions: Create a function that performs a map lookup returning None for null If you do not need a nondefaulted return result using a method reference is preferred map::get
forMapWithDefault(Map<A, B>, B) - Static method in class io.atlassian.fugue.Functions: Create a function that performs a map lookup supplying a default value when a Map#get returns null If you do not need a defaulted return result using a method reference is preferred map::get
fromConsumer(Consumer<D>) - Static method in class io.atlassian.fugue.Functions: Get a function (with Unit return type) that calls the consumer for all inputs.
fromFunction(Function<? super A, ? extends B>, A) - Static method in class io.atlassian.fugue.Suppliers: Constantly applies the input value to the supplied function, and returns the result.
fromOption(Option<A>) - Static method in class io.atlassian.fugue.Suppliers: Turns an Option into a supplier, but throws an exception if undefined.
fromOptional(Optional<A>) - Static method in class io.atlassian.fugue.Option: Factory method for Option instances from Optional instances.
FugueCollectors - Class in io.atlassian.fugue: Collector instances.
FugueCollectors() - Constructor for class io.atlassian.fugue.FugueCollectors
function(Monoid) - Static method in class io.atlassian.fugue.Monoids: A monoid for functions.
function(Semigroup) - Static method in class io.atlassian.fugue.Semigroups: A semigroup for functions.
Functions - Class in io.atlassian.fugue: Utility methods for Functions

G

get() - Method in interface io.atlassian.fugue.Checked.Supplier
get() - Method in class io.atlassian.fugue.Either.LeftProjection
get() - Method in class io.atlassian.fugue.Either.RightProjection
get() - Method in interface io.atlassian.fugue.Maybe: Get the value if defined.
getOr(Supplier<? extends R>) - Method in class io.atlassian.fugue.Either: Get the value if it is a right or call the supplier and return its value if not.
getOr(Supplier<? extends A>) - Method in interface io.atlassian.fugue.Maybe: Get the value if defined or call the supplier and return its value if not.
getOr(Supplier<? extends A>) - Method in class io.atlassian.fugue.Option: Get the value if defined or call the supplier and return its value if not.
getOrElse(Supplier<? extends R>) - Method in class io.atlassian.fugue.Either: Deprecated.
since 4.3, use Either.getOr(Supplier) instead
getOrElse(X) - Method in class io.atlassian.fugue.Either: Get the value if it is a right, otherwise returns other.
getOrElse(B) - Method in interface io.atlassian.fugue.Maybe: Get the value if defined, otherwise returns other.
getOrElse(Supplier<? extends A>) - Method in interface io.atlassian.fugue.Maybe: Deprecated.
since 3.0 Maybe.getOrElse(Supplier) is being replaced with Maybe.getOr(Supplier). In Java 8 type inference cannot disambiguate between an overloaded method taking a generic A and the same method taking a Supplier<A>.
getOrElse(B) - Method in class io.atlassian.fugue.Option: Get the value if defined, otherwise returns other.
getOrElse(Supplier<? extends A>) - Method in class io.atlassian.fugue.Option: Deprecated.
getOrElse(Supplier<A>) - Method in class io.atlassian.fugue.Try: Returns the contained value if this is a success otherwise call the supplier and return its value.
getOrError(Supplier<String>) - Method in class io.atlassian.fugue.Either: Get the contained value or throws an error with the supplied message if left.
getOrError(Supplier<String>) - Method in interface io.atlassian.fugue.Maybe: Get the value or throws an error with the supplied message if not defined.
getOrNull() - Method in class io.atlassian.fugue.Either: Get the value if it is right or null if not.
getOrNull() - Method in interface io.atlassian.fugue.Maybe: Get the value if defined or null if not.
getOrNull() - Method in class io.atlassian.fugue.Option: Get the value if defined or null if not.
getOrThrow(Supplier<X>) - Method in class io.atlassian.fugue.Either: Get the contained value or throws the supplied throwable if left
getOrThrow(Either<X, A>) - Static method in class io.atlassian.fugue.Eithers: Simplifies extracting a value or throwing a checked exception from an Either.
getOrThrow(Supplier<X>) - Method in interface io.atlassian.fugue.Maybe: Get the value or throws the supplied throwable if not defined.

H

hashCode() - Method in class io.atlassian.fugue.Option
hashCode() - Method in class io.atlassian.fugue.Pair

I

identity() - Static method in class io.atlassian.fugue.Functions: Returns the identity function.
intAddition - Static variable in class io.atlassian.fugue.Monoids: A monoid that adds integers.
intersperse(Iterable<? extends A>, A) - Static method in class io.atlassian.fugue.Iterables: Intersperse an element between all the elements in an iterable.
intersperse(Iterable<? extends A>, Supplier<A>) - Static method in class io.atlassian.fugue.Iterables: Intersperse an element between all the elements in an iterable.
intersperse(Iterable<? extends A>, A) - Method in interface io.atlassian.fugue.Monoid: Intersperses the given value between each two elements of the collection, and sums the result.
intMaximum - Static variable in class io.atlassian.fugue.Semigroups: A semigroup that yields the maximum of integers.
intMinimum - Static variable in class io.atlassian.fugue.Semigroups: A semigroup that yields the minimum of integers.
intMultiplication - Static variable in class io.atlassian.fugue.Monoids: A monoid that multiplies integers.
io.atlassian.fugue - package io.atlassian.fugue
io.atlassian.fugue.law - package io.atlassian.fugue.law
isDefined() - Method in class io.atlassian.fugue.Either.LeftProjection
isDefined() - Method in class io.atlassian.fugue.Either.RightProjection
isDefined() - Method in interface io.atlassian.fugue.Maybe: If the type contains a value return true.
isEmpty() - Static method in class io.atlassian.fugue.Iterables: Predicate that checks if an iterable is empty.
isEmpty() - Method in interface io.atlassian.fugue.Maybe: If the type does not contain a value return true.
isEmpty() - Method in class io.atlassian.fugue.Option: If the type does not contain a value return true.
IsEq<A> - Class in io.atlassian.fugue.law: Represents two values of the same type that are expected to be equal.
IsEq(A, A) - Constructor for class io.atlassian.fugue.law.IsEq: Build an equality instance
isEq(A, A) - Static method in class io.atlassian.fugue.law.IsEq: Two equal elements
isFailure() - Method in class io.atlassian.fugue.Try: Returns true if this failure, otherwise false
isInstanceOf(Class) - Static method in class io.atlassian.fugue.Functions: Partial Function that does a type check and matches if the value is of the right type.
isLeft() - Method in class io.atlassian.fugue.Either: Returns true if this either is a left, false otherwise.
isLeft() - Static method in class io.atlassian.fugue.Eithers: A predicate that tests if the supplied either is a left.
isRight() - Method in class io.atlassian.fugue.Either: Returns true if this either is a right, false otherwise.
isRight() - Static method in class io.atlassian.fugue.Eithers: A predicate that tests if the supplied either is a right.
isSuccess() - Method in class io.atlassian.fugue.Try: Returns true if this success, otherwise false
iterable(A...) - Static method in class io.atlassian.fugue.Iterables: Creates an Iterable from the underlying array of elements.
iterable() - Static method in class io.atlassian.fugue.Monoids: A monoid for iterables.
Iterables - Class in io.atlassian.fugue: Contains static utility methods that operate on or return objects of type {code}Iterable{code}.
iterate(Function<? super A, ? extends A>, A) - Static method in class io.atlassian.fugue.Iterables: Returns an infinite Iterable constructed by applying the given iteration function starting at the given value.
iterator() - Method in interface io.atlassian.fugue.Maybe: Return an iterator for this type.
iterator() - Method in class io.atlassian.fugue.Option: Return an iterator for this type.
iterator() - Method in class io.atlassian.fugue.Try: Return an iterator for this type.

J

join(Iterable<? extends Iterable<? extends A>>) - Static method in class io.atlassian.fugue.Iterables: Join Iterable<Iterable<A>> down to Iterable<A>.

L

last() - Static method in class io.atlassian.fugue.Semigroups: Return the last value, ignore the first
lastOption() - Static method in class io.atlassian.fugue.Monoids: A monoid for options that take the last available value.
left(L) - Static method in class io.atlassian.fugue.Either: left.
left() - Method in class io.atlassian.fugue.Either: Projects this either as a left.
left() - Method in class io.atlassian.fugue.Pair: Accessor method for the left value of the pair.
leftMap(Function<? super L, X>) - Method in class io.atlassian.fugue.Either: Map the given function across the left hand side value if it is one.
leftMapper() - Static method in class io.atlassian.fugue.Eithers: A function that maps an either to an option of its left type.
leftOr(Function<R, ? extends L>) - Method in class io.atlassian.fugue.Either: If this is a left return the contained value, else return the result of applying rightTransformer on right
leftValue() - Static method in class io.atlassian.fugue.Pair: Function for accessing the left value of pairs.
lhs() - Method in class io.atlassian.fugue.law.IsEq: Access the left element
lift() - Method in interface io.atlassian.fugue.Checked.Function
lift(Checked.Function<A, B, E>) - Static method in class io.atlassian.fugue.Checked: Lifts a function that potentially throws into a function that either returns a Success of the value or a failure containing the thrown exception.
lift(Function<A, B>) - Static method in class io.atlassian.fugue.Options: Lifts a function that takes an A and returns a B into a function that takes an option of A and returns an option of B.
lift() - Static method in class io.atlassian.fugue.Options: Returns a function that will lift a function that takes an A and returns a B into a function that takes an option of A and returns an option of B.
lift(Predicate<? super A>) - Static method in class io.atlassian.fugue.Options: Lifts a predicate that takes an A into a predicate that takes an option of A.
lift2(BiFunction<A, B, C>) - Static method in class io.atlassian.fugue.Options: Lifts a function that takes an A and a B and returns a C into a function that takes an option of A and an option of B and returns an option of C.
lift2() - Static method in class io.atlassian.fugue.Options: Returns a function that will lift a function that takes an A and a B and returns a C into a function that takes an option of A and an option of B and returns an option of C.
list() - Static method in class io.atlassian.fugue.Monoids: A monoid for lists.
longAddition - Static variable in class io.atlassian.fugue.Monoids: A monoid that adds longs.
longMaximum - Static variable in class io.atlassian.fugue.Semigroups: A semigroup that yields the maximum of longs.
longMinimum - Static variable in class io.atlassian.fugue.Semigroups: A semigroup that yields the minimum of longs.
longMultiplication - Static variable in class io.atlassian.fugue.Monoids: A monoid that multiplies longs.

M

makeString(Iterable<? extends A>, String, String, String, int) - Static method in class io.atlassian.fugue.Iterables: Pretty print an Iterable.
makeString(Iterable<? extends A>, String, String, String) - Static method in class io.atlassian.fugue.Iterables: Pretty print an Iterable.
map(Function<? super L, X>) - Method in class io.atlassian.fugue.Either.LeftProjection: Map the given function across this projection's value if it has one.
map(Function<? super R, X>) - Method in class io.atlassian.fugue.Either: Map the given function across the right hand side value if it is one.
map(Function<? super R, X>) - Method in class io.atlassian.fugue.Either.RightProjection: Map the given function across this projection's value if it has one.
map(Iterable<A>, Function<? super A, ? extends B>) - Static method in class io.atlassian.fugue.Iterables: Apply the input function to each of the elements of the input iterable returning a new iterable
map(Function<? super A, ? extends B>) - Method in class io.atlassian.fugue.Option: Apply f to the value if defined.
map(Pair<A, A>, Function<A, B>) - Static method in class io.atlassian.fugue.Pair: Apply a function to both elements of an homogeneous pair.
map(Function<? super A, ? extends B>) - Method in class io.atlassian.fugue.Try: Maps the given function to the value from this `Success` or returns this unchanged if a `Failure`.
mapNullToOption(Function<? super A, ? extends B>) - Static method in class io.atlassian.fugue.Functions: Maps a function that returns nulls into a Partial function that returns an Option of the result.
match(BiFunction<A, A, R>) - Method in class io.atlassian.fugue.law.IsEq: Function to use for comparison of two equal elements
matches(Function<? super A, ? extends Option<? extends B>>, Function<? super A, ? extends Option<? extends B>>) - Static method in class io.atlassian.fugue.Functions: Creates a stack of matcher functions and returns the first result that matches.
matches(Function<? super A, ? extends Option<? extends B>>, Function<? super A, ? extends Option<? extends B>>, Function<? super A, ? extends Option<? extends B>>) - Static method in class io.atlassian.fugue.Functions: Creates a stack of matcher functions and returns the first result that matches.
matches(Function<? super A, ? extends Option<? extends B>>, Function<? super A, ? extends Option<? extends B>>, Function<? super A, ? extends Option<? extends B>>, Function<? super A, ? extends Option<? extends B>>) - Static method in class io.atlassian.fugue.Functions: Creates a stack of matcher functions and returns the first result that matches.
matches(Function<? super A, ? extends Option<? extends B>>, Function<? super A, ? extends Option<? extends B>>, Function<? super A, ? extends Option<? extends B>>, Function<? super A, ? extends Option<? extends B>>, Function<? super A, ? extends Option<? extends B>>, Function<? super A, ? extends Option<? extends B>>...) - Static method in class io.atlassian.fugue.Functions: Creates a stack of matcher functions and returns the first result that matches.
max(Comparator<A>) - Static method in class io.atlassian.fugue.Semigroups: A semigroup that yields the maximum of by a comparator.
max() - Static method in class io.atlassian.fugue.Semigroups: A semigroup that yields the maximum of comparable values.
Maybe<A> - Interface in io.atlassian.fugue: Implemented by things that may or may not contain a value.
memoize(Iterable<A>) - Static method in class io.atlassian.fugue.Iterables: Makes a lazy copy of xs.
memoize(Supplier<A>) - Static method in class io.atlassian.fugue.Suppliers: A supplier that memoize the value return by another Supplier, whose Supplier.get() method is guaranteed to be call at most once.
merge(Either<T, T>) - Static method in class io.atlassian.fugue.Eithers: Extracts an object from an Either, regardless of the side in which it is stored, provided both sides contain the same type.
mergeSorted(Iterable<? extends Iterable<A>>) - Static method in class io.atlassian.fugue.Iterables: Merge a number of already sorted collections of elements into a single collection of elements, using the elements natural ordering.
mergeSorted(Iterable<? extends Iterable<A>>, Comparator<A>) - Static method in class io.atlassian.fugue.Iterables: Merge a number of already sorted collections of elements into a single collection of elements.
min(Comparator<A>) - Static method in class io.atlassian.fugue.Semigroups: A semigroup that yields the minimum of by a comparator.
min() - Static method in class io.atlassian.fugue.Semigroups: A semigroup that yields the minimum of comparable values.
Monoid<A> - Interface in io.atlassian.fugue: A Monoid is an algebraic structure consisting of an associative binary operation across the values of a given type (a monoid is a Semigroup) and an identity element for this operation.
MonoidLaws<A> - Class in io.atlassian.fugue.law: Laws for a monoid
MonoidLaws(Monoid<A>) - Constructor for class io.atlassian.fugue.law.MonoidLaws: Build a law instance to check monoid properties
monoidLeftIdentity(A) - Method in class io.atlassian.fugue.law.MonoidLaws: If the zero of your monoid is combine with an element of the type your monoid works with the result should be that element.
monoidRightIdentity(A) - Method in class io.atlassian.fugue.law.MonoidLaws: If an element of the type your monoid works with is combined with the zero of your monoid result should be that element.
Monoids - Class in io.atlassian.fugue: Monoid instances.
multiply(int, A) - Method in interface io.atlassian.fugue.Monoid: Returns a value summed n times (a + a + ...
multiply1p(int, A) - Method in interface io.atlassian.fugue.Monoid
multiply1p(int, A) - Method in interface io.atlassian.fugue.Semigroup: Returns a value summed n + 1 times ( a + a + ...
multiply1pEqualRepeatedAppend(int, A) - Method in class io.atlassian.fugue.law.SemigroupLaws: The Semigroup.multiply1p(int, Object) function of your semigroup must be equal to Semigroup.sumNonEmpty(Object, Iterable) applied to the input and an iterable containing n - 1 copies of that input
multiplyEqualRepeatedAppend(int, A) - Method in class io.atlassian.fugue.law.MonoidLaws: The multiply function of your monoid must be equal to the sum function called with an iterable containing n copies of the input type.





N

none() - Static method in class io.atlassian.fugue.Option

Factory method for None instances.

none(Class<A>) - Static method in class io.atlassian.fugue.Option

Factory method for None instances where the type token is handy.

noneSupplier() - Static method in class io.atlassian.fugue.Option

Supplies None as required.

now(Checked.Supplier<A, E>) - Static method in class io.atlassian.fugue.Checked

Create a new Try representing the result of a potentially exception
 throwing operation.

nullSafe(Function<A, B>) - Static method in class io.atlassian.fugue.Options

Turn a null producing function into one that returns an option instead.

nullToOption() - Static method in class io.atlassian.fugue.Functions

Function that turns null inputs into a none, and not-null inputs into some.





O

of(Checked.Supplier<A, E>) - Static method in class io.atlassian.fugue.Checked

Deprecated.
since 4.6 This is being replaced with Checked.now(Supplier) to
 make it clear that the supplier is evaluated immediately. If the evaluation
 needs to be delayed, use Checked.delay(Supplier).


ofInstance(A) - Static method in class io.atlassian.fugue.Suppliers

Creates a Supplier of a constant value.

on(Function<? super R, ? extends L>) - Method in class io.atlassian.fugue.Either.LeftProjection
 
on(Function<? super B, ? extends A>) - Method in interface io.atlassian.fugue.Either.Projection

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

on(Function<? super L, ? extends R>) - Method in class io.atlassian.fugue.Either.RightProjection
 
option(Semigroup<A>) - Static method in class io.atlassian.fugue.Monoids

A monoid for options that combine inner value with a semigroup.

Option<A> - Class in io.atlassian.fugue

A class that encapsulates missing values.

option(A) - Static method in class io.atlassian.fugue.Option

Factory method for Option instances.

Options - Class in io.atlassian.fugue

Utility methods for working with options.

orElse(Either<? extends L, ? extends R>) - Method in class io.atlassian.fugue.Either

If this is a right, return the same right.

orElse(Supplier<? extends Either<? extends L, ? extends R>>) - Method in class io.atlassian.fugue.Either

If this is a right, return the same right.

orElse(Option<? extends A>) - Method in class io.atlassian.fugue.Option

If this is a some, return the same some.

orElse(Supplier<? extends Option<? extends A>>) - Method in class io.atlassian.fugue.Option

If this is a some, return the same some.

orElse(Try<? extends A>) - Method in class io.atlassian.fugue.Try

If this is a success, return the same success.

orElse(Supplier<? extends Try<? extends A>>) - Method in class io.atlassian.fugue.Try

If this is a success, return the same success.





P

Pair<A,B> - Class in io.atlassian.fugue

Represents a pair of objects.

Pair(A, B) - Constructor for class io.atlassian.fugue.Pair

Constructor for Pair.

pair(A, B) - Static method in class io.atlassian.fugue.Pair

Factory method for static Pair growth.

pairs() - Static method in class io.atlassian.fugue.Pair

Factory method for a Pair factory function.

partial(Predicate<? super A>, Function<? super A, ? extends B>) - Static method in class io.atlassian.fugue.Functions

Create a PartialFunction from a Predicate and a
 Function.

partition(Iterable<A>, Predicate<? super A>) - Static method in class io.atlassian.fugue.Iterables

Filter an Iterable into a Pair of Iterable's.





R

rangeTo(int, int) - Static method in class io.atlassian.fugue.Iterables

Creates a sequence of integers from start up to and
 including end.

rangeTo(int, int, int) - Static method in class io.atlassian.fugue.Iterables

Creates a sequence of integers from start up to and
 including end with the the supplied step between them.

rangeUntil(int, int) - Static method in class io.atlassian.fugue.Iterables

Creates a sequence of integers from start up to but not
 including end.

rangeUntil(int, int, int) - Static method in class io.atlassian.fugue.Iterables

Creates a sequence of integers from start up to but not
 including end with the the supplied step between them.

recover(Function<? super Exception, A>) - Method in class io.atlassian.fugue.Try

Applies the given function `f` if this is a `Failure` otherwise this
 unchanged if a 'Success'.

recover(Class<X>, Function<? super X, A>) - Method in class io.atlassian.fugue.Try

Applies the given function `f` if this is a `Failure` with certain
 exception type otherwise leaves this unchanged.

recoverWith(Function<? super Exception, Try<A>>) - Method in class io.atlassian.fugue.Try

Binds the given function across the failure value if it is one, otherwise
 this unchanged if a 'Success'.

recoverWith(Class<X>, Function<? super X, Try<A>>) - Method in class io.atlassian.fugue.Try

Binds the given function across certain exception type if it is one,
 otherwise this unchanged.

revMap(Iterable<? extends Function<A, B>>, A) - Static method in class io.atlassian.fugue.Iterables

Applies each function in fs to arg.

rhs() - Method in class io.atlassian.fugue.law.IsEq

Access the right element

right(R) - Static method in class io.atlassian.fugue.Either


 right.

right() - Method in class io.atlassian.fugue.Either

Projects this either as a right.

right() - Method in class io.atlassian.fugue.Pair

Accessor method for the right value of the pair.q

rightMapper() - Static method in class io.atlassian.fugue.Eithers

A function that maps an either to an option of its right type.

rightOr(Function<L, ? extends R>) - Method in class io.atlassian.fugue.Either

If this is a right return the contained value, else return the result of
 applying leftTransformer on left

rightValue() - Static method in class io.atlassian.fugue.Pair

Function for accessing the right value of pairs.





S

Semigroup<A> - Interface in io.atlassian.fugue

A Semigroup is an algebraic structure consisting of an associative binary
 operation across the values of a given type (the Semigroup type argument).

semigroupAssociative(A, A, A) - Method in class io.atlassian.fugue.law.MonoidLaws

A monoid must not care about the order elements are combined.

semigroupAssociative(A, A, A) - Method in class io.atlassian.fugue.law.SemigroupLaws

A semigroup must not care about the order elements are combined.

SemigroupLaws<A> - Class in io.atlassian.fugue.law

Laws for a semigroup

SemigroupLaws(Semigroup<A>) - Constructor for class io.atlassian.fugue.law.SemigroupLaws

Build a law instance to check semigroup properties

Semigroups - Class in io.atlassian.fugue

Semigroup instances.

sequence(Either<X, R>) - Method in class io.atlassian.fugue.Either.LeftProjection

Anonymous bind through this projection.

sequence(Either<L, X>) - Method in class io.atlassian.fugue.Either.RightProjection

Anonymous bind through this projection.

sequence(Either<L, X>) - Method in class io.atlassian.fugue.Either

Will return the supplied Either if this one is right, otherwise this one if
 left.

sequence(Iterable<Try<A>>) - Static method in class io.atlassian.fugue.Try

Returns a success wrapping all of the values if all of the arguments were a
 success, otherwise this returns the first failure

sequence(Iterable<Try<T>>, Collector<T, A, R>) - Static method in class io.atlassian.fugue.Try

Returns a success wrapping all of the values if all of the arguments were a
 success, otherwise this returns the first failure

sequenceLeft(Iterable<Either<L, R>>) - Static method in class io.atlassian.fugue.Eithers

Collect the left values if there are only lefts, otherwise return the first
 right encountered.

sequenceLeft(Iterable<Either<L, R>>, Collector<L, A, C>) - Static method in class io.atlassian.fugue.Eithers

Collect the left values if there are only lefts, otherwise return the first
 right encountered.

sequenceRight(Iterable<Either<L, R>>) - Static method in class io.atlassian.fugue.Eithers

Collect the right values if there are only rights, otherwise return the
 first left encountered.

sequenceRight(Iterable<Either<L, R>>, Collector<R, A, C>) - Static method in class io.atlassian.fugue.Eithers

Collect the right values if there are only rights, otherwise return the
 first left encountered.

size(Iterable<A>) - Static method in class io.atlassian.fugue.Iterables

Return the size of an iterable.

some(A) - Static method in class io.atlassian.fugue.Option

Factory method for Some instances.

string - Static variable in class io.atlassian.fugue.Monoids

A monoid that appends strings.

successful(A) - Static method in class io.atlassian.fugue.Try

Creates a new Success

sum(Iterable<A>) - Method in interface io.atlassian.fugue.Monoid

Sums the given values.

sumEqualFold(Iterable<A>) - Method in class io.atlassian.fugue.law.MonoidLaws

The sum function of your monoid must be equal to
 Functions.fold(BiFunction, Object, Iterable) using append as the
 folding function and zero() as the initial value

sumNonEmpty(A, Iterable<A>) - Method in interface io.atlassian.fugue.Monoid
 
sumNonEmpty(A, Iterable<A>) - Method in interface io.atlassian.fugue.Semigroup

Reduce a 'non-empty' Iterable with Semigroup.append(Object, Object)

sumNonEmptyEqualFold(A, Iterable<A>) - Method in class io.atlassian.fugue.law.SemigroupLaws

The Semigroup.sumNonEmpty(Object, Iterable) function of your
 semigroup must be equal to a
 Functions.fold(BiFunction, Object, Iterable) where append is used
 as the combining function, head is used as the initial value and tail is
 the iterable to check

Suppliers - Class in io.atlassian.fugue

Provide utility functions for the class of functions that supply a return
 value when invoked.

Suppliers() - Constructor for class io.atlassian.fugue.Suppliers
 
swap() - Method in class io.atlassian.fugue.Either

If this is a left, then return the left value in right, or vice versa.





T

take(int, Iterable<A>) - Static method in class io.atlassian.fugue.Iterables

Aakes the first n as and returns them.

takeWhile(Iterable<A>, Predicate<A>) - Static method in class io.atlassian.fugue.Iterables

Return a new iterable containing only the first elements of as for
 which p#test returns true.

toBiFunction(Function<Pair<A, B>, C>) - Static method in class io.atlassian.fugue.Functions

Converts a function that takes a pair of arguments to a function that takes
 two arguments

toEither() - Method in class io.atlassian.fugue.Try

Convert this Try to an Either, becoming a left if this is a failure
 and a right if this is a success.

toEitherLeft() - Static method in class io.atlassian.fugue.FugueCollectors

Collect the left values if there are only lefts, otherwise return the first
 right encountered.

toEitherLeft(Collector<L, A, B>) - Static method in class io.atlassian.fugue.FugueCollectors

Collect the left values if there are only lefts, otherwise return the first
 right encountered.

toEitherRight() - Static method in class io.atlassian.fugue.FugueCollectors

Collect the right values if there are only rights, otherwise return the
 first left encountered.

toEitherRight(Collector<R, A, B>) - Static method in class io.atlassian.fugue.FugueCollectors

Collect the right values if there are only rights, otherwise return the
 first left encountered.

toLeft() - Static method in class io.atlassian.fugue.Eithers

Function to convert from an value to a
 Either.Left containing that value.

toLeft(Class<L>, Class<R>) - Static method in class io.atlassian.fugue.Eithers

Function to convert from a value to a
 Either.Left containing that value.

toLeft(L) - Static method in class io.atlassian.fugue.Eithers

Supplier returning a Either.Left.

toLeft(L, Class<R>) - Static method in class io.atlassian.fugue.Eithers

Supplier returning a Either.Left.

toLeft(Supplier<X>) - Method in class io.atlassian.fugue.Option

Creates an Either from this Option.

toOption() - Method in interface io.atlassian.fugue.Either.Projection

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

toOption() - Method in class io.atlassian.fugue.Either

Convert this Either to an Option.

toOption() - Static method in class io.atlassian.fugue.Options

Function for wrapping values in a Some or None.

toOption() - Method in class io.atlassian.fugue.Try

Convert this Try to an Option.

toOptional() - Method in interface io.atlassian.fugue.Either.Projection

Returns this projection's value in Optional.of(T) if it exists,
 otherwise Optional.empty().

toOptional() - Method in class io.atlassian.fugue.Either

Convert this Either to an Optional.

toOptional() - Method in class io.atlassian.fugue.Option

Create an Optional from this option.

toOptional() - Method in class io.atlassian.fugue.Try

Create a Optional from this try.

toRight() - Static method in class io.atlassian.fugue.Eithers

Function to convert from an value to a
 Either.Right.

toRight(Class<L>, Class<R>) - Static method in class io.atlassian.fugue.Eithers

Function to convert from a value to a
 Either.Right containing that value.

toRight(R) - Static method in class io.atlassian.fugue.Eithers

Supplier returning a Either.Right.

toRight(Class<L>, R) - Static method in class io.atlassian.fugue.Eithers

Supplier returning a Either.Right.

toRight(Supplier<X>) - Method in class io.atlassian.fugue.Option

Creates an Either from this Option.

toStream() - Method in interface io.atlassian.fugue.Either.Projection

Returns this projection's value in Stream.of(T) if it exists,
 otherwise Stream.empty().

toStream() - Method in class io.atlassian.fugue.Either

Convert this Either to a Stream.

toStream() - Method in class io.atlassian.fugue.Option

Create a Stream from this option.

toStream() - Method in class io.atlassian.fugue.Try

Create a Stream from this try.

toString() - Method in class io.atlassian.fugue.Option
toString() - Method in class io.atlassian.fugue.Pair
toTrySuccess() - Static method in class io.atlassian.fugue.FugueCollectors

Collect the right values if there are only successes, otherwise return the
 first failure encountered.

toTrySuccess(Collector<A, B, C>) - Static method in class io.atlassian.fugue.FugueCollectors

Collect the right values if there are only successes, otherwise return the
 first failure encountered.

transform(Iterable<A>, Function<? super A, ? extends B>) - Static method in class io.atlassian.fugue.Iterables

Deprecated.
function provided to make migration easier prefer to use #map
 where possible


Try<A> - Class in io.atlassian.fugue

A Try represents a computation that may either throw an
 exception or return a value.

Try() - Constructor for class io.atlassian.fugue.Try
 




U

unfold(Function<? super B, Option<Pair<A, B>>>, B) - Static method in class io.atlassian.fugue.Iterables

Builds an Iterable from a seed value until f returns none()
 .

unit - Static variable in class io.atlassian.fugue.Monoids

A monoid for the Unit value.

Unit - Enum in io.atlassian.fugue

An alternative to Void that is actually once inhabited
 (whereas Void is inhabited by null, which causes NPEs).

Unit() - Static method in enum io.atlassian.fugue.Unit

Provide ability to statically import Unit.UNIT and then use
 UNIT() within your code, primarily for readability purposes.

unzip(Iterable<Pair<A, B>>) - Static method in class io.atlassian.fugue.Iterables

Unzips an iterable of pairs into a pair of
 iterables.

upcast(Option<A>) - Static method in class io.atlassian.fugue.Options

Upcasts an option of type A to an option of its super type
 AA.

upcastLeft(Either<L, R>) - Static method in class io.atlassian.fugue.Eithers

Upcasts an either of left type L to an either of left type
 LL, which is a super type of L, keeping the right type unchanged.

upcastRight(Either<L, R>) - Static method in class io.atlassian.fugue.Eithers

Upcasts an either of right type R to an either of right type
 RR, which is a super type of R, keeping the left type unchanged.





V

valueOf(String) - Static method in enum io.atlassian.fugue.Unit

Returns the enum constant of this type with the specified name.

valueOr(Function<L, ? extends R>) - Method in class io.atlassian.fugue.Either

Deprecated.
In favor of rightOr


values() - Static method in enum io.atlassian.fugue.Unit

Returns an array containing the constants of this enum type, in
the order they are declared.





W

weakMemoize(Function<A, B>) - Static method in class io.atlassian.fugue.Functions

Takes a Function and memoizes (caches) the result for each input.

weakMemoize(Supplier<A>) - Static method in class io.atlassian.fugue.Suppliers

A supplier that weakly memoize the value return by another
 Supplier , The returned
 Supplier is thread-safe





Z

zero() - Method in interface io.atlassian.fugue.Monoid

The identity element value for this monoid.

zip(Iterable<A>, Iterable<B>) - Static method in class io.atlassian.fugue.Iterables

Zips two iterables into a single iterable that produces pairs.

zip(Iterable<A>, Iterable<B>) - Static method in class io.atlassian.fugue.Pair

Zips two iterables into a single iterable that produces pairs.

zip(Optional<A>, Optional<B>) - Static method in class io.atlassian.fugue.Pair

Zips the two given optionals into an optional of a pair.

zipWith(BiFunction<A, B, C>) - Static method in class io.atlassian.fugue.Iterables

Takes a two-arg function that returns a third type and reurn a new function
 that takes iterables of the two input types and combines them into a new
 iterable.

zipWithIndex(Iterable<A>) - Static method in class io.atlassian.fugue.Iterables

Takes an Iterable, and returns an Iterable of a Pair of the original
 element and its index starting at zero.


A B C D E F G H I J L M N O P R S T U V W Z