de.ipcon.tools.graph

Interface GraphEdgeFilterI

All Known Implementing Classes:

EntityI.NonPersistentEdgeFilter

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 GraphEdgeFilterI

Interface to be implemented by classes which can filter GraphEdgeI instances according to some criteria.

As this interface contains a single abstract method, it is a FunctionalInterface and can be implemented using a lambda expression (e.g., edge -> edge.getWeight() > 10) or a method reference in Java 8 and later.

Method Summary

Modifier and Type	Method and Description
static GraphEdgeFilterI	acceptAll() Returns a filter that always evaluates to true.
default GraphEdgeFilterI	and(GraphEdgeFilterI other) Returns a composed filter that represents a short-circuiting logical AND of this filter and another.
boolean	fits(GraphEdgeI edge) Checks if the given graph edge meets the filter's criteria.
default GraphEdgeFilterI	negate() Returns a filter that represents the logical negation of this filter.
default GraphEdgeFilterI	or(GraphEdgeFilterI other) Returns a composed filter that represents a short-circuiting logical OR of this filter and another.
static GraphEdgeFilterI	rejectAll() Returns a filter that always evaluates to false.

Method Detail

fits

boolean fits(GraphEdgeI edge)

Checks if the given graph edge meets the filter's criteria.

Parameters:

edge - The GraphEdgeI instance to check. Implementations should define behavior for null inputs, though typically callers should avoid passing null.

Returns:

true if the edge meets the criteria (i.e., "fits"), false otherwise.

and

default GraphEdgeFilterI and(GraphEdgeFilterI other)

Returns a composed filter that represents a short-circuiting logical AND of this filter and another. When evaluating the composed filter, if this filter is false, then the other filter is not evaluated.

Parameters:

other - a GraphEdgeFilterI that will be logically-ANDed with this filter

Returns:

a composed filter that represents the short-circuiting logical AND of this filter and the other filter

Throws:

java.lang.NullPointerException - if other is null

or

default GraphEdgeFilterI or(GraphEdgeFilterI other)

Returns a composed filter that represents a short-circuiting logical OR of this filter and another. When evaluating the composed filter, if this filter is true, then the other filter is not evaluated.

Parameters:

other - a GraphEdgeFilterI that will be logically-ORed with this filter

Returns:

a composed filter that represents the short-circuiting logical OR of this filter and the other filter

Throws:

java.lang.NullPointerException - if other is null

negate

default GraphEdgeFilterI negate()

Returns a filter that represents the logical negation of this filter.

Returns:

a filter that represents the logical negation of this filter

acceptAll

static GraphEdgeFilterI acceptAll()

Returns a filter that always evaluates to true.

Returns:

A filter that accepts all edges.

rejectAll

static GraphEdgeFilterI rejectAll()

Returns a filter that always evaluates to false.

Returns:

A filter that rejects all edges.