io.vavr

Interface PartialFunction<T,R>

Type Parameters:

T - type of the function input, called domain of the function

R - type of the function output, called codomain of the function

All Superinterfaces:

java.util.function.Function<T,R>, Function1<T,R>, java.io.Serializable

All Known Subinterfaces:

API.Match.Case<T,R>, API.Match.Pattern<T,R>, IndexedSeq<T>, LinearSeq<T>, Map<K,V>, Multimap<K,V>, Seq<T>, SortedMap<K,V>, SortedMultimap<K,V>

All Known Implementing Classes:

API.Match.Case0, API.Match.Case1, API.Match.Case2, API.Match.Case3, API.Match.Case4, API.Match.Case5, API.Match.Case6, API.Match.Case7, API.Match.Case8, API.Match.Pattern0, API.Match.Pattern1, API.Match.Pattern2, API.Match.Pattern3, API.Match.Pattern4, API.Match.Pattern5, API.Match.Pattern6, API.Match.Pattern7, API.Match.Pattern8, Array, CharSeq, HashMap, HashMultimap, LinkedHashMap, LinkedHashMultimap, List, List.Cons, List.Nil, Queue, Stream, Stream.Cons, Stream.Empty, TreeMap, TreeMultimap, Vector

Deprecated.

Will be removed in the next major version, along with VAVR's pattern matching, in favor of Java's native pattern matching.

@Deprecated
public interface PartialFunction<T,R>
extends Function1<T,R>

Represents a partial function T -> R that is not necessarily defined for all input values of type T. The caller is responsible for calling the method isDefinedAt() before this function is applied to the value.

If the function is not defined for a specific value, apply() may produce an arbitrary result. More specifically it is not guaranteed that the function will throw an exception.

If the function is defined for a specific value, apply() may still throw an exception.

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID Deprecated. The serial version uid.

Method Summary

Modifier and Type	Method and Description
R	apply(T t) Deprecated. Applies this function to the given argument and returns the result.
boolean	isDefinedAt(T value) Deprecated. Tests if a value is contained in the function's domain.
default Function1<T,Option<R>>	lift() Deprecated. Lifts this partial function into a total function that returns an Option result.

Methods inherited from interface io.vavr.Function1

andThen, arity, compose, constant, curried, identity, isMemoized, lift, liftTry, memoized, narrow, of, partial, reversed, tupled

Field Detail

serialVersionUID

static final long serialVersionUID

Deprecated.

The serial version uid.

See Also:

Constant Field Values

Method Detail

apply

R apply(T t)

Deprecated.

Applies this function to the given argument and returns the result.

Specified by:

apply in interface java.util.function.Function<T,R>

Specified by:

apply in interface Function1<T,R>

Parameters:

t - the argument

Returns:

the result of function application

isDefinedAt

boolean isDefinedAt(T value)

Deprecated.

Tests if a value is contained in the function's domain.

Parameters:

value - a potential function argument

Returns:

true, if the given value is contained in the function's domain, false otherwise

lift

default Function1<T,Option<R>> lift()

Deprecated.

Lifts this partial function into a total function that returns an Option result.

Returns:

a function that applies arguments to this function and returns Some(result) if the function is defined for the given arguments, and None otherwise.