org.springframework.data.gemfire.support

Interface CompositeTypeFilter

All Superinterfaces:

TypeFilter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface CompositeTypeFilter
extends TypeFilter

A Spring TypeFilter implementation using the Composite Software Design Pattern to compose multiple TypeFilters acting a single instance of TypeFilter.

Since:

2.4.0

Author:

John Blum

See Also:

TypeFilter, Composite Software Design Pattern

Field Summary

Fields

Modifier and Type	Field and Description
static CompositeTypeFilter	ALLOW
static CompositeTypeFilter	DENY

Method Summary

Modifier and Type	Method and Description
default CompositeTypeFilter	andThen(TypeFilter typeFilter) Composes this TypeFilter with the given TypeFilter using the logical AND operator.
static TypeFilter	composeAnd(Iterable<TypeFilter> iterable) Composes the Iterable of TypeFilters into a Composite TypeFilter that acts as a single instance of TypeFilter.
static TypeFilter	composeAnd(TypeFilter... array) Composes the array of TypeFilters into a Composite TypeFilter that acts as a single instance of TypeFilter.
static TypeFilter	composeOr(Iterable<TypeFilter> iterable) Composes the Iterable of TypeFilters into a Composite TypeFilter that acts as a single instance of TypeFilter.
static TypeFilter	composeOr(TypeFilter... array) Composes the array of TypeFilters into a Composite TypeFilter that acts as a single instance of TypeFilter.
default CompositeTypeFilter	negate() Negates the result of this TypeFilter's TypeFilter.match(MetadataReader, MetadataReaderFactory) operation.
static CompositeTypeFilter	of(TypeFilter typeFilter) Wraps an existing TypeFilter in an instance of CompositeTypeFilter.
default CompositeTypeFilter	orThen(TypeFilter typeFilter) Composes this TypeFilter with the given TypeFilter using the logical OR operator.

Methods inherited from interface org.springframework.core.type.filter.TypeFilter

match

Field Detail

ALLOW

static final CompositeTypeFilter ALLOW

DENY

static final CompositeTypeFilter DENY

Method Detail

andThen

@NonNull
default CompositeTypeFilter andThen(@NonNull
                                             TypeFilter typeFilter)

Composes this TypeFilter with the given TypeFilter using the logical AND operator.

Parameters:

typeFilter - TypeFilter to compose with this TypeFilter; must not be null.

Returns:

a composed TypeFilter consisting of this TypeFilter and the given TypeFilter.

Throws:

IllegalArgumentException - if TypeFilter is null.

See Also:

TypeFilter, orThen(TypeFilter)

composeAnd

@Nullable
static TypeFilter composeAnd(@Nullable
                                       TypeFilter... array)

Composes the array of TypeFilters into a Composite TypeFilter that acts as a single instance of TypeFilter. The Composite TypeFilter may be treated as a single instance of TypeFilter, too, given CompositeTypeFilter extends (i.e. "is a") TypeFilter.

Parameters:

array - array of TypeFilters to compose.

Returns:

a Composite TypeFilter composed from the array of TypeFilers using the logical AND operator; may return null.

See Also:

TypeFilter, composeAnd(Iterable)

composeAnd

@Nullable
static TypeFilter composeAnd(@Nullable
                                       Iterable<TypeFilter> iterable)

Composes the Iterable of TypeFilters into a Composite TypeFilter that acts as a single instance of TypeFilter. The Composite TypeFilter may be treated as a single instance of TypeFilter, too, given CompositeTypeFilter extends (i.e. "is a") TypeFilter.

Parameters:

iterable - Iterable of TypeFilters to compose.

Returns:

a Composite TypeFilter composed from the Iterable of TypeFilers using the logical AND operator; may return null.

See Also:

TypeFilter, Iterable

composeOr

@Nullable
static TypeFilter composeOr(@Nullable
                                      TypeFilter... array)

Composes the array of TypeFilters into a Composite TypeFilter that acts as a single instance of TypeFilter. The Composite TypeFilter may be treated as a single instance of TypeFilter, too, given CompositeTypeFilter extends (i.e. "is a") TypeFilter.

Parameters:

array - array of TypeFilters to compose.

Returns:

a Composite TypeFilter composed from the array of TypeFilers using the logical OR operator; may return null.

See Also:

TypeFilter, composeOr(Iterable)

composeOr

@Nullable
static TypeFilter composeOr(@Nullable
                                      Iterable<TypeFilter> iterable)

Composes the Iterable of TypeFilters into a Composite TypeFilter that acts as a single instance of TypeFilter. The Composite TypeFilter may be treated as a single instance of TypeFilter, too, given CompositeTypeFilter extends (i.e. "is a") TypeFilter.

Parameters:

iterable - Iterable of TypeFilters to compose.

Returns:

a Composite TypeFilter composed from the Iterable of TypeFilers using the logical OR operator; may return null.

See Also:

TypeFilter, Iterable

of

@NonNull
static CompositeTypeFilter of(@NonNull
                                       TypeFilter typeFilter)

Wraps an existing TypeFilter in an instance of CompositeTypeFilter.

Parameters:

typeFilter - TypeFilter to wrap; must not be null.

Returns:

a CompositeTypeFilter wrapping the existing TypeFilter.

Throws:

IllegalArgumentException - if TypeFilter is null.

See Also:

TypeFilter

negate

@NonNull
default CompositeTypeFilter negate()

Negates the result of this TypeFilter's TypeFilter.match(MetadataReader, MetadataReaderFactory) operation.

Returns:

this TypeFilter negated.

See Also:

CompositeTypeFilter

orThen

@NonNull
default CompositeTypeFilter orThen(@NonNull
                                            TypeFilter typeFilter)

Composes this TypeFilter with the given TypeFilter using the logical OR operator.

Parameters:

typeFilter - TypeFilter to compose with this TypeFilter; must not be null.

Returns:

a composed TypeFilter consisting of this TypeFilter and the given TypeFilter.

Throws:

IllegalArgumentException - if TypeFilter is null.

See Also:

TypeFilter, andThen(TypeFilter)