OptiGUI/opekope2.optigui.filter

Package-level declarations

Types

class ConditionalFilter<TInput, TResult : Any>(check: (TInput) -> Boolean, falseResult: TResult?, filter: IFilter<TInput, TResult>) : IFilter<TInput, TResult> , Iterable<IFilter<TInput, TResult>>

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

ConjunctionFilter

class ConjunctionFilter<TInput>(filters: Collection<IFilter<TInput, *>>) : IFilter<TInput, Unit> , Iterable<IFilter<TInput, *>>

A filter, which applies the logical AND operation between the given filters, and returns a non-null value, if all the sub-filters returned a non-null value, or null, if any of the sub-filters returned null.

ContainingFilter

class ContainingFilter<TInput>(collection: Collection<TInput>) : IFilter<TInput, Unit> , Iterable<TInput>

A filter, which only returns a non-null value, if the given collection contains the input.

DisjunctionFilter

class DisjunctionFilter<TInput>(filters: Collection<IFilter<TInput, *>>) : IFilter<TInput, Unit> , Iterable<IFilter<TInput, *>>

A filter, which applies the logical OR operation between the given filters and returns a non-null value, if any of the sub-filters returned a non-null value, or null, if all the sub-filters returned null.

EqualityFilter

class EqualityFilter<TInput>(expectedValue: TInput) : IFilter<TInput, Unit>

A filter, which only returns a non-null value, when the input is expectedValue.

FirstMatchFilter

open class FirstMatchFilter<TInput, TResult : Any>(filters: Collection<IFilter<TInput, out TResult>>) : IFilter<TInput, TResult> , Iterable<IFilter<TInput, out TResult>>

A filter, which returns the first non-null evaluation from filters. It returns null, if none of filters return a non-null value, or filters is empty.

IFilter

fun interface IFilter<TInput, TResult : Any>

Functional interface for filtering.

InputNullGuardFilter

class InputNullGuardFilter<TInput, TResult : Any>(inputNullResult: TResult?, filter: IFilter<TInput, TResult>) : IFilter<TInput?, TResult> , Iterable<IFilter<TInput, TResult>>

A filter, which forwards evaluation to the given filter, if the input is not null. If the input is null, the filter will return inputNullResult.

NegationFilter

class NegationFilter<TInput>(filter: IFilter<TInput, *>) : IFilter<TInput, Unit> , Iterable<IFilter<TInput, *>>

A filter, which returns null, if filter returns a non-null value, and returns a non-null value, if filter returns null.

PostProcessorFilter

class PostProcessorFilter<TInput, TSubFilterResult : Any, TResult : Any>(filter: IFilter<TInput, out TSubFilterResult>, transformDescription: String, transform: (input: TInput, result: TSubFilterResult?) -> TResult?) : IFilter<TInput, TResult> , Iterable<IFilter<TInput, out TSubFilterResult>>

A post-processor filter, which changes the output of the given sub-filter.

PreProcessorFilter

class PreProcessorFilter<TInput, TSubFilterInput, TResult : Any>(transform: (TInput) -> TSubFilterInput, transformDescription: String, filter: IFilter<TSubFilterInput, TResult>) : IFilter<TInput, TResult> , Iterable<IFilter<TSubFilterInput, TResult>>

A pre-processor filter, which applies a transform to the value before evaluating the sub-filter on it.

RangeFilter

class RangeFilter : IFilter<Int, Unit>

A filter, which returns a non-null value only when the input number is withing the defined range.

RegularExpressionFilter

class RegularExpressionFilter(regex: Regex) : IFilter<String, Unit>

A filter, which returns a non-null value only when regex matches the input String.