Package net.kyori.examination.string

Class StringExaminer

java.lang.Object

net.kyori.examination.AbstractExaminer<String>

net.kyori.examination.string.StringExaminer

All Implemented Interfaces:

net.kyori.examination.Examiner<String>

public class StringExaminer
extends net.kyori.examination.AbstractExaminer<String>

Examiner that outputs a String.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
StringExaminer(@NotNull Function<String,String> escaper)	Constructs.

Method Summary

Modifier and Type	Method	Description
protected @NotNull String	array(int length, IntFunction<String> value)
protected <E> @NotNull String	array(E @NotNull [] array, @NotNull Stream<String> elements)
protected <E> @NotNull String	collection(@NotNull Collection<E> collection, @NotNull Stream<String> elements)
protected @NotNull String	examinable(@NotNull String name, @NotNull Stream<Map.Entry<String,String>> properties)
@NotNull String	examine(boolean value)
@NotNull String	examine(byte value)
@NotNull String	examine(char value)
@NotNull String	examine(double value)
@NotNull String	examine(float value)
@NotNull String	examine(int value)
@NotNull String	examine(long value)
@NotNull String	examine(short value)
@NotNull String	examine(@Nullable String value)
protected <K,V> @NotNull String	map(@NotNull Map<K,V> map, @NotNull Stream<Map.Entry<String,String>> entries)
protected @NotNull String	nil()
protected @NotNull String	scalar(@NotNull Object value)
static @NotNull StringExaminer	simpleEscaping()	Gets a string examiner that escapes simply.
protected @NotNull String	stream(@NotNull DoubleStream stream)
protected @NotNull String	stream(@NotNull IntStream stream)
protected @NotNull String	stream(@NotNull LongStream stream)
protected <T> @NotNull String	stream(@NotNull Stream<T> stream)

Methods inherited from class net.kyori.examination.AbstractExaminer

examine, examine, examine, examine, examine, examine, examine, examine, examine, examine

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.kyori.examination.Examiner

examine

Constructor Detail

StringExaminer

public StringExaminer(@NotNull
                      @NotNull Function<String,String> escaper)

Constructs.

Parameters:

escaper - the string escaper

Since:

1.0.0

Method Detail

simpleEscaping

@NotNull
public static @NotNull StringExaminer simpleEscaping()

Gets a string examiner that escapes simply.

Returns:

a string examiner

Since:

1.0.0

array

@NotNull
protected <E> @NotNull String array(E @NotNull [] array,
                                    @NotNull
                                    @NotNull Stream<String> elements)

Specified by:

array in class net.kyori.examination.AbstractExaminer<String>

collection

@NotNull
protected <E> @NotNull String collection(@NotNull
                                         @NotNull Collection<E> collection,
                                         @NotNull
                                         @NotNull Stream<String> elements)

Specified by:

collection in class net.kyori.examination.AbstractExaminer<String>

examinable

@NotNull
protected @NotNull String examinable(@NotNull
                                     @NotNull String name,
                                     @NotNull
                                     @NotNull Stream<Map.Entry<String,String>> properties)

Specified by:

examinable in class net.kyori.examination.AbstractExaminer<String>

map

@NotNull
protected <K,V> @NotNull String map(@NotNull
                                          @NotNull Map<K,V> map,
                                          @NotNull
                                          @NotNull Stream<Map.Entry<String,String>> entries)

Specified by:

map in class net.kyori.examination.AbstractExaminer<String>

nil

@NotNull
protected @NotNull String nil()

Specified by:

nil in class net.kyori.examination.AbstractExaminer<String>

scalar

@NotNull
protected @NotNull String scalar(@NotNull
                                 @NotNull Object value)

Specified by:

scalar in class net.kyori.examination.AbstractExaminer<String>

examine

@NotNull
public @NotNull String examine(boolean value)

examine

@NotNull
public @NotNull String examine(byte value)

examine

@NotNull
public @NotNull String examine(char value)

examine

@NotNull
public @NotNull String examine(double value)

examine

@NotNull
public @NotNull String examine(float value)

examine

@NotNull
public @NotNull String examine(int value)

examine

@NotNull
public @NotNull String examine(long value)

examine

@NotNull
public @NotNull String examine(short value)

stream

@NotNull
protected <T> @NotNull String stream(@NotNull
                                     @NotNull Stream<T> stream)

Specified by:

stream in class net.kyori.examination.AbstractExaminer<String>

stream

@NotNull
protected @NotNull String stream(@NotNull
                                 @NotNull DoubleStream stream)

Specified by:

stream in class net.kyori.examination.AbstractExaminer<String>

stream

@NotNull
protected @NotNull String stream(@NotNull
                                 @NotNull IntStream stream)

Specified by:

stream in class net.kyori.examination.AbstractExaminer<String>

stream

@NotNull
protected @NotNull String stream(@NotNull
                                 @NotNull LongStream stream)

Specified by:

stream in class net.kyori.examination.AbstractExaminer<String>

examine

@NotNull
public @NotNull String examine(@Nullable
                               @Nullable String value)

array

@NotNull
protected @NotNull String array(int length,
                                IntFunction<String> value)

Specified by:

array in class net.kyori.examination.AbstractExaminer<String>