team.unnamed.creative.base

Interface KeyPattern

All Superinterfaces:

net.kyori.examination.Examinable

public interface KeyPattern
extends net.kyori.examination.Examinable

Represents a Key pattern or predicate, uses regular expressions to match Key.namespace()'s and/or Key.value()'s

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
static @NotNull KeyPattern	any() Creates a new KeyPattern instance that will filter any file
@Nullable java.util.regex.Pattern	namespace() Returns the key's namespace pattern to match.
static @NotNull KeyPattern	of(@Nullable java.util.regex.Pattern namespace, @Nullable java.util.regex.Pattern value) Creates a new KeyPattern instance that will filter keys using the specified namespace pattern and value pattern
static @NotNull KeyPattern	of(@Nullable java.lang.String namespace, @Nullable java.lang.String value) Creates a new KeyPattern instance that will filter keys using the specified namespace pattern and value pattern
static @NotNull KeyPattern	ofNamespace(@Nullable java.util.regex.Pattern namespace) Creates a new KeyPattern instance that will filter keys using the specified namespace pattern and will filter any value
static @NotNull KeyPattern	ofNamespace(@Nullable java.lang.String namespace) Creates a new KeyPattern instance that will filter keys using the specified namespace pattern and will filter any value
static @NotNull KeyPattern	ofValue(@Nullable java.util.regex.Pattern value) Creates a new KeyPattern instance that will filter keys using the specified value pattern and will apply to every namespace
static @NotNull KeyPattern	ofValue(@Nullable java.lang.String value) Creates a new KeyPattern instance that will filter keys using the specified value pattern and will apply to every namespace
boolean	test(@NotNull net.kyori.adventure.key.Key key) Tests if the given Key matches with this pattern.
@Nullable java.util.regex.Pattern	value() Returns the key's value pattern to match.

Methods inherited from interface net.kyori.examination.Examinable

examinableName, examinableProperties, examine

Method Detail

namespace

@Nullable
@Nullable java.util.regex.Pattern namespace()

Returns the key's namespace pattern to match.

If null, it will apply to every namespace

Returns:

The namespace pattern

Since:

1.0.0

value

@Nullable
@Nullable java.util.regex.Pattern value()

Returns the key's value pattern to match.

If null, it will apply to every value

Returns:

The value pattern

Since:

1.0.0

test

boolean test(@NotNull
             @NotNull net.kyori.adventure.key.Key key)

Tests if the given Key matches with this pattern. Results match with Minecraft Vanilla Client tests

Parameters:

key - The tested key

Returns:

True if it matches and should be filtered

of

@NotNull
static @NotNull KeyPattern of(@Nullable
                                        @Nullable java.util.regex.Pattern namespace,
                                        @Nullable
                                        @Nullable java.util.regex.Pattern value)

Creates a new KeyPattern instance that will filter keys using the specified namespace pattern and value pattern

Parameters:

namespace - The namespace pattern

value - The value pattern

Returns:

A new KeyPattern instance

Since:

1.0.0

of

@NotNull
static @NotNull KeyPattern of(@RegExp @Nullable
                                        @Nullable java.lang.String namespace,
                                        @RegExp @Nullable
                                        @Nullable java.lang.String value)

Creates a new KeyPattern instance that will filter keys using the specified namespace pattern and value pattern

Parameters:

namespace - The namespace pattern

value - The value pattern

Returns:

A new KeyPattern instance

Since:

1.0.0

ofNamespace

@NotNull
static @NotNull KeyPattern ofNamespace(@Nullable
                                                 @Nullable java.util.regex.Pattern namespace)

Creates a new KeyPattern instance that will filter keys using the specified namespace pattern and will filter any value

Parameters:

namespace - The namespace pattern

Returns:

A new KeyPattern instance

Since:

1.0.0

ofNamespace

@NotNull
static @NotNull KeyPattern ofNamespace(@RegExp @Nullable
                                                 @Nullable java.lang.String namespace)

Creates a new KeyPattern instance that will filter keys using the specified namespace pattern and will filter any value

Parameters:

namespace - The namespace pattern

Returns:

A new KeyPattern instance

Since:

1.0.0

ofValue

@NotNull
static @NotNull KeyPattern ofValue(@Nullable
                                             @Nullable java.util.regex.Pattern value)

Creates a new KeyPattern instance that will filter keys using the specified value pattern and will apply to every namespace

Parameters:

value - The value pattern

Returns:

A new KeyPattern instance

Since:

1.0.0

ofValue

@NotNull
static @NotNull KeyPattern ofValue(@RegExp @Nullable
                                             @Nullable java.lang.String value)

Creates a new KeyPattern instance that will filter keys using the specified value pattern and will apply to every namespace

Parameters:

value - The value pattern

Returns:

A new KeyPattern instance

Since:

1.0.0

any

@NotNull
static @NotNull KeyPattern any()

Creates a new KeyPattern instance that will filter any file

Returns:

The filtering pattern

Since:

1.0.0