net.lenni0451.mcstructs.nbt.io.internal

Interface NbtWriteWrapper

All Known Implementing Classes:

NbtIO

@ParametersAreNonnullByDefault
public interface NbtWriteWrapper

A wrapper class containing methods to write Nbt tags to different sources.

Method Summary

Modifier and Type	Method and Description
INbtWriter	getWriter()
default void	write(java.io.DataOutput out, java.lang.String name, INbtTag tag) Write a Nbt tag to a DataOutput.
default void	write(java.io.OutputStream os, java.lang.String name, INbtTag tag, boolean compressed) Write a Nbt tag to an output stream.
default void	writeCompressedFile(java.io.File f, java.lang.String name, INbtTag tag) Write a compressed Nbt tag to a file.
default void	writeFile(java.io.File f, java.lang.String name, INbtTag tag) Write and uncompressed Nbt tag to a file.
default void	writeFile(java.io.File f, java.lang.String name, INbtTag tag, boolean compressed) Write a Nbt tag to a file.
default void	writeUnnamed(java.io.DataOutput out, INbtTag tag) Write an unnamed Nbt tag to a DataOutput.

Method Detail

getWriter

INbtWriter getWriter()

writeFile

default void writeFile(java.io.File f,
                       java.lang.String name,
                       INbtTag tag)
                throws java.io.IOException

Write and uncompressed Nbt tag to a file.

Parameters:

f - The file to write to

name - The name of the tag (should be "" if not required)

tag - The tag to write

Throws:

java.io.IOException - If an I/O error occurs

writeCompressedFile

default void writeCompressedFile(java.io.File f,
                                 java.lang.String name,
                                 INbtTag tag)
                          throws java.io.IOException

Write a compressed Nbt tag to a file.

Parameters:

f - The file to write to

name - The name of the tag (should be "" if not required)

tag - The tag to write

Throws:

java.io.IOException - If an I/O error occurs

writeFile

default void writeFile(java.io.File f,
                       java.lang.String name,
                       INbtTag tag,
                       boolean compressed)
                throws java.io.IOException

Write a Nbt tag to a file.

Parameters:

f - The file to write to

name - The name of the tag (should be "" if not required)

tag - The tag to write

compressed - Whether the file should be compressed or not

Throws:

java.io.IOException - If an I/O error occurs

write

@WillClose
default void write(java.io.OutputStream os,
                               java.lang.String name,
                               INbtTag tag,
                               boolean compressed)
                        throws java.io.IOException

Write a Nbt tag to an output stream.

Parameters:

os - The output stream to write to

name - The name of the tag (should be "" if not required)

tag - The tag to write

compressed - Whether the output stream should be compressed or not

Throws:

java.io.IOException - If an I/O error occurs

write

@WillNotClose
default void write(java.io.DataOutput out,
                                  java.lang.String name,
                                  INbtTag tag)
                           throws java.io.IOException

Write a Nbt tag to a DataOutput.

Parameters:

out - The data output to write to

name - The name of the tag (should be "" if not required)

tag - The tag to write

Throws:

java.io.IOException - If an I/O error occurs

writeUnnamed

@WillNotClose
default void writeUnnamed(java.io.DataOutput out,
                                         INbtTag tag)
                                  throws java.io.IOException

Write an unnamed Nbt tag to a DataOutput.
Unnamed tags are a network only feature of Minecraft 1.20.2+!
You probably need to use write(DataOutput, String, INbtTag) instead!

Parameters:

out - The data output to write to

tag - The tag to write

Throws:

java.io.IOException - If an I/O error occurs