NodeFilter (org.macroing.cit.java API)

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 NodeFilter
```
A filter that accepts or rejects a Node, based on some criterion.
You may use a concrete implementation of this interface in combination with the static methods provided.
Some of the static methods take an instance of Node as their first parameter argument and an instance of NodeFilter as their second and returns a List with the Nodes that satisfies said criterion.

Since:

1.0.0

Author:

Jörgen Lundgren

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static NodeFilter`	`and(NodeFilter... nodeFilters)` Returns a `NodeFilter` that accepts all `Node`s that are accepted by all of the aggregated `NodeFilter`s.
`static NodeFilter`	`any()` Returns a `NodeFilter` that accepts any `Node`.
`static java.util.List<Node>`	`filter(Node node)` Returns a `List` with all `Node`s.
`static java.util.List<Node>`	`filter(Node node, NodeFilter nodeFilter)` Returns a `List` with the `Node`s that satisfies the criterion specified by `nodeFilter`.
`static <T extends Node> java.util.List<T>`	`filter(Node node, NodeFilter nodeFilter, java.lang.Class<T> clazz)` Returns a `List` with the `Node`s that satisfies the criterion specified by `nodeFilter`, but only if they are assignment compatible to `clazz`.
`boolean`	`isAccepted(Node node)` Returns `true` if, and only if, `node` is accepted, `false` otherwise.
`static NodeFilter`	`or(NodeFilter... nodeFilters)` Returns a `NodeFilter` that accepts all `Node`s that are accepted by at least one of the aggregated `NodeFilter`s.
`static NodeFilter`	`regex(java.lang.String regex)` Returns a `NodeFilter` that accepts all `Node`s that have a `toString()` method that matches the given Regex.

- Method Detail
  - isAccepted
```
boolean isAccepted(Node node)
```
    Returns true if, and only if, node is accepted, false otherwise.
    If node is null, a NullPointerException may be thrown. But no guarantees can be made.
    
    Parameters:
    
    node - the Node to accept or reject
    
    Returns:
    
    true if, and only if, node is accepted, false otherwise
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, node is null
  - and
```
static NodeFilter and(NodeFilter... nodeFilters)
```
    Returns a NodeFilter that accepts all Nodes that are accepted by all of the aggregated NodeFilters.
    This means that this NodeFilter does not on its own contain any filtering logic. The logic that determines whether a Node is accepted or rejected, is fully up to the aggregated NodeFilters.
    When isAccepted(Node) is called, it iterates over the aggregated NodeFilters until either one of them rejects the Node, in which case false is returned, or all of them accepts, in which case true is returned.
    If either nodeFilters, or at least one of its elements are null, a NullPointerException will be thrown.
    The NodeFilter returned by this method will throw a NullPointerException if, and only if, the Node to accept or reject is null.
    
    Parameters:
    
    nodeFilters - the aggregated NodeFilters that make up the filtering logic
    
    Returns:
    
    a NodeFilter that accepts all Nodes that are accepted by all of the aggregated NodeFilters
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either nodeFilters, or at least one of its elements are null
  - any
```
static NodeFilter any()
```
    Returns a NodeFilter that accepts any Node.
    The NodeFilter returned by this method will throw a NullPointerException if, and only if, the Node to accept or reject is null.
    
    Returns:
    
    a NodeFilter that accepts any Node
  - or
```
static NodeFilter or(NodeFilter... nodeFilters)
```
    Returns a NodeFilter that accepts all Nodes that are accepted by at least one of the aggregated NodeFilters.
    This means that this NodeFilter does not on its own contain any filtering logic. The logic that determines whether a Node is accepted or rejected, is fully up to the aggregated NodeFilters.
    When isAccepted(Node) is called, it iterates over the aggregated NodeFilters until either one of them accepts the Node, in which case true is returned, or none of them does, in which case false is returned.
    If either nodeFilters, or at least one of its elements are null, a NullPointerException will be thrown.
    The NodeFilter returned by this method will throw a NullPointerException if, and only if, the Node to accept or reject is null.
    
    Parameters:
    
    nodeFilters - the aggregated NodeFilters that make up the filtering logic
    
    Returns:
    
    a NodeFilter that accepts all Nodes that are accepted by at least one of the aggregated NodeFilters
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either nodeFilters, or at least one of its elements are null
  - regex
```
static NodeFilter regex(java.lang.String regex)
```
    Returns a NodeFilter that accepts all Nodes that have a toString() method that matches the given Regex.
    If regex is null, a NullPointerException will be thrown.
    The NodeFilter returned by this method will throw a NullPointerException if, and only if, the Node to accept or reject is null.
    
    Parameters:
    
    regex - a String representing the Regex to be used in the filtering process
    
    Returns:
    
    a NodeFilter that accepts all Nodes that have a toString() method that matches the given Regex
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, regex is null
  - filter
```
static java.util.List<Node> filter(Node node)
```
    Returns a List with all Nodes.
    All Nodes are found by traversing node using a simple NodeHierarchicalVisitor implementation.
    If node is null, a NullPointerException will be thrown.
    
    Parameters:
    
    node - the Node to start traversal from
    
    Returns:
    
    a List with all Nodes
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, node is null
  - filter
```
static java.util.List<Node> filter(Node node,
                                   NodeFilter nodeFilter)
```
    Returns a List with the Nodes that satisfies the criterion specified by nodeFilter.
    All Nodes are found by traversing node using a simple NodeHierarchicalVisitor implementation.
    If either node or nodeFilter are null, a NullPointerException will be thrown.
    
    Parameters:
    
    node - the Node to start traversal from
    
    nodeFilter - the NodeFilter to accept or reject Nodes
    
    Returns:
    
    a List with the Nodes that satisfies the criterion specified by nodeFilter
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either node or nodeFilter are null
  - filter
```
static <T extends Node> java.util.List<T> filter(Node node,
                                                 NodeFilter nodeFilter,
                                                 java.lang.Class<T> clazz)
```
    Returns a List with the Nodes that satisfies the criterion specified by nodeFilter, but only if they are assignment compatible to clazz.
    The List returned will be cast to the Class specified by clazz.
    All Nodes are found by traversing node using a simple NodeHierarchicalVisitor implementation.
    If either node, nodeFilter or clazz are null, a NullPointerException will be thrown.
    
    Type Parameters:
    
    T - the type the List should be cast to
    
    Parameters:
    
    node - the Node to start traversal from
    
    nodeFilter - the NodeFilter to accept or reject Nodes
    
    clazz - the Class that is of the type T
    
    Returns:
    
    a List with the Nodes that satisfies the criterion specified by nodeFilter, but only if they are assignment compatible to clazz
    
    Throws:
    
    java.lang.NullPointerException - thrown if, and only if, either node, nodeFilter or clazz are null

Interface NodeFilter

Method Summary

Method Detail

isAccepted

and

any

or

regex

filter

filter

filter