Package com.github.siroshun09.mccommand.common.filter

Class StringFilter

java.lang.Object

com.github.siroshun09.mccommand.common.filter.AbstractFilter<String>

com.github.siroshun09.mccommand.common.filter.StringFilter

All Implemented Interfaces:

Filter<String>, Predicate<String>

public final class StringFilter
extends AbstractFilter<String>

A class that implements Filter for the String.

Field Summary

Fields

Modifier and Type	Field	Description
static StringFilter	IS_EMPTY	The filter if the String is empty.
static StringFilter	IS_NOT_EMPTY	The filter if the String is not empty.

Method Summary

Modifier and Type	Method	Description
static @NotNull StringFilter	create(@NotNull Predicate<String> predicate)	Creates the StringFilter.
static @NotNull StringFilter	endsWith(@NotNull String suffix)	Creates a filter to check if the String ends with the specified String.
static @NotNull StringFilter	endsWithIgnoreCase(@NotNull String suffix)	Creates a filter to check if the String ends with the specified String.
static @NotNull StringFilter	lengthRange(@org.jetbrains.annotations.Range(from=0L, to=2147483647L) int min, @org.jetbrains.annotations.Range(from=0L, to=2147483647L) int max)	Creates a filter to check the length of String.
static @NotNull StringFilter	maxLength(@org.jetbrains.annotations.Range(from=0L, to=2147483647L) int max)	Creates a filter to check the length of String.
static @NotNull StringFilter	minLength(@org.jetbrains.annotations.Range(from=0L, to=2147483647L) int min)	Creates a filter to check the length of String.
static @NotNull StringFilter	regex(@NotNull String regex)	Create a filter using a regular expression.
static @NotNull StringFilter	regex(@NotNull Pattern pattern)	Create a filter using a Pattern.
static @NotNull StringFilter	startsWith(@NotNull String prefix)	Creates a filter to check if the String starts with the specified String.
static @NotNull StringFilter	startsWithIgnoreCase(@NotNull String prefix)	Creates a filter to check if the String starts with the specified String.

Methods inherited from class com.github.siroshun09.mccommand.common.filter.AbstractFilter

test

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, negate, or

Field Detail

IS_EMPTY

public static final StringFilter IS_EMPTY

The filter if the String is empty.

IS_NOT_EMPTY

public static final StringFilter IS_NOT_EMPTY

The filter if the String is not empty.

Method Detail

create

@Contract(value="_ -> new",
          pure=true)
@NotNull
public static @NotNull StringFilter create(@NotNull
                                           @NotNull Predicate<String> predicate)

Creates the StringFilter.

Parameters:

predicate - the predicate to test the String

Returns:

the StringFilter

startsWith

@Contract(value="_ -> new",
          pure=true)
@NotNull
public static @NotNull StringFilter startsWith(@NotNull
                                               @NotNull String prefix)

Creates a filter to check if the String starts with the specified String.

Parameters:

prefix - the prefix

Returns:

the StringFilter

startsWithIgnoreCase

@Contract(value="_ -> new",
          pure=true)
@NotNull
public static @NotNull StringFilter startsWithIgnoreCase(@NotNull
                                                         @NotNull String prefix)

Creates a filter to check if the String starts with the specified String.

This filter is not case-sensitive.

Parameters:

prefix - the prefix

Returns:

the StringFilter

endsWith

@Contract(value="_ -> new",
          pure=true)
@NotNull
public static @NotNull StringFilter endsWith(@NotNull
                                             @NotNull String suffix)

Creates a filter to check if the String ends with the specified String.

Parameters:

suffix - the suffix

Returns:

the StringFilter

endsWithIgnoreCase

@Contract(value="_ -> new",
          pure=true)
@NotNull
public static @NotNull StringFilter endsWithIgnoreCase(@NotNull
                                                       @NotNull String suffix)

Creates a filter to check if the String ends with the specified String.

This filter is not case-sensitive.

Parameters:

suffix - the suffix

Returns:

the StringFilter

lengthRange

@Contract(value="_ -> new",
          pure=true)
@NotNull
public static @NotNull StringFilter lengthRange(@org.jetbrains.annotations.Range(from=0L, to=2147483647L) int min,
                                                @org.jetbrains.annotations.Range(from=0L, to=2147483647L) int max)
                                         throws IllegalArgumentException

Creates a filter to check the length of String.

Parameters:

min - minimum length

max - maximum length

Returns:

the StringFilter

Throws:

IllegalArgumentException - if the minimum or maximum value is less than zero or if the minimum value is greater than the maximum value

maxLength

@Contract(value="_ -> new",
          pure=true)
@NotNull
public static @NotNull StringFilter maxLength(@org.jetbrains.annotations.Range(from=0L, to=2147483647L) int max)

Creates a filter to check the length of String.

Parameters:

max - maximum length

Returns:

the StringFilter

Throws:

IllegalArgumentException - if the maximum value is less than zero

minLength

@Contract(value="_ -> new",
          pure=true)
@NotNull
public static @NotNull StringFilter minLength(@org.jetbrains.annotations.Range(from=0L, to=2147483647L) int min)

Creates a filter to check the length of String.

Parameters:

min - minimum length

Returns:

the StringFilter

Throws:

IllegalArgumentException - if the minimum value is less than zero

regex

@Contract(value="_ -> new",
          pure=true)
@NotNull
public static @NotNull StringFilter regex(@NotNull
                                          @NotNull String regex)

Create a filter using a regular expression.

Parameters:

regex - the regex

Returns:

the StringFilter

regex

@Contract(value="_ -> new",
          pure=true)
@NotNull
public static @NotNull StringFilter regex(@NotNull
                                          @NotNull Pattern pattern)

Create a filter using a Pattern.

Parameters:

pattern - the pattern

Returns:

the StringFilter