Package-level declarations

Types

Link copied to clipboard
class ConditionalFilter<T, TResult>(check: (T) -> Boolean, falseResult: FilterResult<TResult>, filter: Filter<T, TResult>) : Filter<T, TResult> , Iterable<Filter<T, TResult>>

A filter, which forwards evaluation to the given filter, if the check function returns true. Otherwise, the result will be falseResult.

Link copied to clipboard
class ConjunctionFilter<T>(filters: Iterable<Filter<T, out Any>>) : Filter<T, Unit> , Iterable<Filter<T, out Any>>

A filter, which applies the logical AND operation between the given filters and returns the result. Only skips if all sub-filters skip, and only yields match if no sub-filters yield mismatch.

Link copied to clipboard
class ContainingFilter<T>(collection: Collection<T>) : Filter<T, Unit> , Iterable<T>

A filter, which only yields a matching result if the given collection contains the input. This filter never skips.

Link copied to clipboard
class DisjunctionFilter<T>(filters: Iterable<Filter<T, out Any>>) : Filter<T, Unit> , Iterable<Filter<T, out Any>>

A filter, which applies the logical OR operation between the given filters and returns the result. Only skips if all sub-filters skip, and only yields mismatch if no sub-filters yield match.

Link copied to clipboard
class EqualityFilter<T>(expectedValue: T) : Filter<T, Unit>

A filter, which succeeds when the given value is expectedValue, fails otherwise, and never skips.

Link copied to clipboard
fun interface Filter<T, TResult>

Functional interface for filtering.

Link copied to clipboard
interface FilterResult<T>

Represents a filter result.

Link copied to clipboard

A filter, which returns the first FilterResult.Match result from filters. Only skips if all sub-filters skip, and only yields mismatch if no sub-filters yield match.

Link copied to clipboard
class InequalityFilter<T>(unexpectedValue: T) : Filter<T, Unit>

A filter, which fails when the given value is unexpectedValue, succeeds otherwise, and never skips.

Link copied to clipboard
class NegationFilter<T>(filter: Filter<T, out Any>) : Filter<T, Unit> , Iterable<Filter<T, out Any>>

A filter, which returns the opposite result of the provided filter.

Link copied to clipboard

A filter, which forwards evaluation to the given filter, unless the input is null; in this case, the result will be nullResult.

Link copied to clipboard

Basically a NullGuardFilter for Java users using Optional.

Link copied to clipboard
class PostProcessorFilter<T, TFilterResult, TResult>(filter: Filter<T, out TFilterResult>, transform: (input: T, result: FilterResult<out TFilterResult>) -> FilterResult<out TResult>) : Filter<T, TResult> , Iterable<Filter<T, out TFilterResult>>

A post-processor filter, which enables the output of the given sub-filter to be changed.

Link copied to clipboard

A pre-processor filter, which applies a transform to the value before evaluating the sub-filter on it. For more advanced control over invoking filter, please use an arrow function.

Link copied to clipboard

A filter, which yields a successful result only when the input number is within the defined range, and never skips.

Link copied to clipboard

A filter, yields a successful result only, when the provided regular expression matches the input.