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 Known Subinterfaces:

API.Match.Case<T,R>, API.Match.Pattern<T,R>

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

public interface PartialFunction<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.

Author:

Daniel Dietrich

Method Summary

Modifier and Type	Method and Description
R	apply(T t) Applies this function to the given argument and returns the result.
boolean	isDefinedAt(T value) Tests if a value is contained in the function's domain.

Method Detail

apply

R apply(T t)

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

Parameters:

t - the argument

Returns:

the result of function application

isDefinedAt

boolean isDefinedAt(T value)

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