Package net.kyori.adventure.nbt

Class TagStringIO

java.lang.Object

net.kyori.adventure.nbt.TagStringIO

public final class TagStringIO
extends Object

A holder for string tag format options.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TagStringIO.Builder	Builder for a SNBT I/O handler.

Method Summary

Modifier and Type	Method	Description
@NotNull CompoundBinaryTag	asCompound(@NotNull String input)	Read the string into a compound tag structure.
@NotNull CompoundBinaryTag	asCompound(@NotNull String input, @NotNull Appendable remainder)	Read the string into an embedded compound tag, returning the remainder of the input.
@NotNull String	asString(@NotNull BinaryTag input)	Get a string representation of the provided tag.
@NotNull String	asString(@NotNull CompoundBinaryTag input)	Get a string representation of the provided tag.
@NotNull BinaryTag	asTag(@NotNull String input)	Read the string into a tag.
@NotNull BinaryTag	asTag(@NotNull String input, @NotNull Appendable remainder)	Read the string into an embedded tag, returning the remainder of the input.
static @NotNull TagStringIO.Builder	builder()	Create a new builder to configure IO.
static @NotNull TagStringIO	get()	Deprecated. For removal since 4.22.0, use tagStringIO() instead
static @NotNull TagStringIO	tagStringIO()	Gets an instance of TagStringIO that reads and writes using standard options.
void	toWriter(@NotNull BinaryTag input, @NotNull Writer dest)	Writes a tag to in string format.
void	toWriter(@NotNull CompoundBinaryTag input, @NotNull Writer dest)	Writes a compound tag to in string format.

Methods inherited from class java.lang.Object

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

Method Details

get

@Deprecated
@NotNull
public static @NotNull TagStringIO get()

Deprecated.

For removal since 4.22.0, use tagStringIO() instead

Get an instance of TagStringIO that reads and writes using standard options.

Returns:

the basic instance

Since:

4.0.0

tagStringIO

@NotNull
public static @NotNull TagStringIO tagStringIO()

Gets an instance of TagStringIO that reads and writes using standard options.

Returns:

the basic instance

Since:

4.22.0

builder

@NotNull
public static @NotNull TagStringIO.Builder builder()

Create a new builder to configure IO.

Returns:

a builder

Since:

4.0.0

asCompound

@NotNull
public @NotNull CompoundBinaryTag asCompound(@NotNull
 @NotNull String input)
                                      throws IOException

Read the string into a compound tag structure.

When working with untrusted input (such as from the network), users should be careful to validate that the input string is of a reasonable size.

Parameters:

input - Input data

Returns:

this

Throws:

IOException - on any syntax errors

Since:

4.0.0

asTag

@NotNull
public @NotNull BinaryTag asTag(@NotNull
 @NotNull String input)
                         throws IOException

Read the string into a tag.

When working with untrusted input (such as from the network), users should be careful to validate that the input string is of a reasonable size.

Parameters:

input - Input data

Returns:

the parsed tag

Throws:

IOException - on any syntax errors

Since:

4.22.0

asCompound

@NotNull
public @NotNull CompoundBinaryTag asCompound(@NotNull
 @NotNull String input,
 @NotNull
 @NotNull Appendable remainder)
                                      throws IOException

Read the string into an embedded compound tag, returning the remainder of the input.

Parameters:

input - the input string

remainder - the appendable to write the remainder to

Returns:

the parsed tag with the remainder

Throws:

IOException - on any syntax errors

Since:

4.22.0

asTag

@NotNull
public @NotNull BinaryTag asTag(@NotNull
 @NotNull String input,
 @NotNull
 @NotNull Appendable remainder)
                         throws IOException

Read the string into an embedded tag, returning the remainder of the input.

Parameters:

input - the input string

remainder - the appendable to write the remainder to

Returns:

the parsed tag with the remainder

Throws:

IOException - on any syntax errors

Since:

4.22.0

asString

@NotNull
public @NotNull String asString(@NotNull
 @NotNull CompoundBinaryTag input)
                         throws IOException

Get a string representation of the provided tag.

Parameters:

input - tag to serialize

Returns:

serialized form

Throws:

IOException - if any errors occur writing to string

Since:

4.0.0

asString

@NotNull
public @NotNull String asString(@NotNull
 @NotNull BinaryTag input)
                         throws IOException

Get a string representation of the provided tag.

Parameters:

input - tag to serialize

Returns:

serialized form

Throws:

IOException - if any errors occur writing to string

Since:

4.20.0

toWriter

public void toWriter(@NotNull
 @NotNull CompoundBinaryTag input,
 @NotNull
 @NotNull Writer dest)
              throws IOException

Writes a compound tag to in string format.

The provided Writer will remain open after reading a tag.

Parameters:

input - Tag to write

dest - Writer to write to

Throws:

IOException - if any IO or syntax errors occur while parsing

Since:

4.0.0

toWriter

public void toWriter(@NotNull
 @NotNull BinaryTag input,
 @NotNull
 @NotNull Writer dest)
              throws IOException

Writes a tag to in string format.

The provided Writer will remain open after reading a tag.

Parameters:

input - Tag to write

dest - Writer to write to

Throws:

IOException - if any IO or syntax errors occur while parsing

Since:

4.22.0