de.ipcon.tools.graph

Interface GraphNodeMatcherI<N extends OnlyToDirectedGraphNodeI>

Type Parameters:

N - The specific type of graph node this matcher can operate on. Must extend OnlyToDirectedGraphNodeI.

All Known Implementing Classes:

EntityI.EntityMatcher

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 GraphNodeMatcherI<N extends OnlyToDirectedGraphNodeI>

Defines criteria that graph node objects (implementing OnlyToDirectedGraphNodeI) must meet to be considered a "match". This interface provides a method to check nodes against these criteria.

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

Method Summary

Modifier and Type	Method and Description
static <T extends OnlyToDirectedGraphNodeI> GraphNodeMatcherI<T>	acceptAll() Returns a matcher that accepts all nodes of type T.
default GraphNodeMatcherI<N>	and(GraphNodeMatcherI<? super N> other) Returns a composed matcher that represents a short-circuiting logical AND of this matcher and another.
boolean	fits(N node) Checks if the given node matches the criteria defined by this matcher.
default GraphNodeMatcherI<N>	negate() Returns a matcher that represents the logical negation of this matcher.
static <T extends OnlyToDirectedGraphNodeI> GraphNodeMatcherI<T>	ofType(java.lang.Class<? extends T> type) Returns a matcher that checks if a node is an instance of a specific class.
default GraphNodeMatcherI<N>	or(GraphNodeMatcherI<? super N> other) Returns a composed matcher that represents a short-circuiting logical OR of this matcher and another.
static <T extends OnlyToDirectedGraphNodeI> GraphNodeMatcherI<T>	rejectAll() Returns a matcher that rejects all nodes of type T.

Method Detail

fits

boolean fits(N node)

Checks if the given node matches the criteria defined by this matcher.

Parameters:

node - The graph node (of type N) to check against the matcher's criteria. Implementations should define behavior for null inputs, though typically callers should avoid passing null.

Returns:

true if the given node matches the criteria of this matcher; false otherwise.

and

default GraphNodeMatcherI<N> and(GraphNodeMatcherI<? super N> other)

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

Parameters:

other - a GraphNodeMatcherI (for type N or its supertypes) that will be logically-ANDed with this matcher. Using <? super N> for flexibility.

Returns:

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

Throws:

java.lang.NullPointerException - if other is null

or

default GraphNodeMatcherI<N> or(GraphNodeMatcherI<? super N> other)

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

Parameters:

other - a GraphNodeMatcherI (for type N or its supertypes) that will be logically-ORed with this matcher. Using <? super N> for flexibility.

Returns:

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

Throws:

java.lang.NullPointerException - if other is null

negate

default GraphNodeMatcherI<N> negate()

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

Returns:

a matcher that represents the logical negation of this matcher

acceptAll

static <T extends OnlyToDirectedGraphNodeI> GraphNodeMatcherI<T> acceptAll()

Returns a matcher that accepts all nodes of type T.

Type Parameters:

T - The type of the node.

Returns:

A matcher that accepts all nodes.

rejectAll

static <T extends OnlyToDirectedGraphNodeI> GraphNodeMatcherI<T> rejectAll()

Returns a matcher that rejects all nodes of type T.

Type Parameters:

T - The type of the node.

Returns:

A matcher that rejects all nodes.

ofType

static <T extends OnlyToDirectedGraphNodeI> GraphNodeMatcherI<T> ofType(java.lang.Class<? extends T> type)

Returns a matcher that checks if a node is an instance of a specific class.

Type Parameters:

T - The base type of the node.

Parameters:

type - The class to match against.

Returns:

A matcher that checks node type.

Throws:

java.lang.NullPointerException - if type is null