net.kyori.xml.node.filter

Class NodeFilters

java.lang.Object

net.kyori.xml.node.filter.NodeFilters

public final class NodeFilters
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static @NonNull NodeFilter	alwaysFalse() Gets a node filter that returns a constant value of false.
static @NonNull NodeFilter	alwaysTrue() Gets a node filter that returns a constant value of true.
static @NonNull NodeFilter	minimumDepth(int minimumDepth) Gets a node filter that returns true when the depth is at least minimumDepth.
static @NonNull NodeFilter	named(@NonNull java.util.Set<java.lang.String> names) Gets a node filter that returns true if names contains the name of the node.
static @NonNull NodeFilter	named(java.lang.String... names) Gets a node filter that returns true if names contains the name of the node.
static @NonNull NodeFilter	named(@NonNull java.lang.String name) Gets a node filter that returns true if names is equal to the name of the node.
static @NonNull NodeFilter	onlyAttributes() Gets a node filter that returns true when the node is a AttributeNode.
static @NonNull NodeFilter	onlyElements() Gets a node filter that returns true when the node is a ElementNode.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

alwaysFalse

public static @NonNull NodeFilter alwaysFalse()

Gets a node filter that returns a constant value of false.

Returns:

a node filter

alwaysTrue

public static @NonNull NodeFilter alwaysTrue()

Gets a node filter that returns a constant value of true.

Returns:

a node filter

onlyAttributes

public static @NonNull NodeFilter onlyAttributes()

Gets a node filter that returns true when the node is a AttributeNode.

Returns:

a node filter

onlyElements

public static @NonNull NodeFilter onlyElements()

Gets a node filter that returns true when the node is a ElementNode.

Returns:

a node filter

minimumDepth

public static @NonNull NodeFilter minimumDepth(int minimumDepth)

Gets a node filter that returns true when the depth is at least minimumDepth.

Parameters:

minimumDepth - the minimum depth

Returns:

a node filter

named

public static @NonNull NodeFilter named(@NonNull java.lang.String name)

Gets a node filter that returns true if names is equal to the name of the node.

Parameters:

name - the name

Returns:

a node filter

named

public static @NonNull NodeFilter named(java.lang.String... names)

Gets a node filter that returns true if names contains the name of the node.

Parameters:

names - the names

Returns:

a node filter

named

public static @NonNull NodeFilter named(@NonNull java.util.Set<java.lang.String> names)

Gets a node filter that returns true if names contains the name of the node.

Parameters:

names - the names

Returns:

a node filter