team.unnamed.creative.serialize.minecraft

Interface MinecraftResourcePackReader

All Superinterfaces:

team.unnamed.creative.serialize.ResourcePackReader<FileTreeReader>

public interface MinecraftResourcePackReader
extends team.unnamed.creative.serialize.ResourcePackReader<FileTreeReader>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MinecraftResourcePackReader.Builder A builder for MinecraftResourcePackReader instances.

Method Summary

Modifier and Type	Method and Description
static @NotNull MinecraftResourcePackReader.Builder	builder() Returns a new MinecraftResourcePackReader.Builder instance.
static @NotNull MinecraftResourcePackReader	minecraft() Returns the standard MinecraftResourcePackReader instance.
@NotNull team.unnamed.creative.ResourcePack	read(@NotNull FileTreeReader tree)
default team.unnamed.creative.ResourcePack	readFromDirectory(java.io.File directory)
default @NotNull team.unnamed.creative.ResourcePack	readFromInputStream(@NotNull java.io.InputStream stream) Reads a ResourcePack from a given InputStream.
default @NotNull team.unnamed.creative.ResourcePack	readFromZipFile(@NotNull java.io.File file) Reads a ResourcePack from a given ZIP file.
default @NotNull team.unnamed.creative.ResourcePack	readFromZipFile(@NotNull java.nio.file.Path path) Reads a ResourcePack from a ZIP file at the given path.

Method Detail

minecraft

@NotNull
static @NotNull MinecraftResourcePackReader minecraft()

Returns the standard MinecraftResourcePackReader instance.

If any customization is needed, use the builder() method to change any options.

Returns:

The standard Minecraft resource pack reader instance

Since:

1.0.0

builder

@Contract(value="-> new")
 @NotNull
static @NotNull MinecraftResourcePackReader.Builder builder()

Returns a new MinecraftResourcePackReader.Builder instance.

Returns:

The builder instance

Since:

1.3.0

read

@NotNull
@NotNull team.unnamed.creative.ResourcePack read(@NotNull
                                                           @NotNull FileTreeReader tree)

Specified by:

read in interface team.unnamed.creative.serialize.ResourcePackReader<FileTreeReader>

readFromZipFile

@NotNull
default @NotNull team.unnamed.creative.ResourcePack readFromZipFile(@NotNull
                                                                              @NotNull java.nio.file.Path path)

Reads a ResourcePack from a ZIP file at the given path.

Parameters:

path - The path to the ZIP file

Returns:

The read resource pack

Since:

1.0.0

readFromZipFile

@NotNull
default @NotNull team.unnamed.creative.ResourcePack readFromZipFile(@NotNull
                                                                              @NotNull java.io.File file)

Reads a ResourcePack from a given ZIP file.

Parameters:

file - The ZIP file

Returns:

The read resource pack

Since:

1.0.0

readFromInputStream

@NotNull
default @NotNull team.unnamed.creative.ResourcePack readFromInputStream(@NotNull
                                                                                  @NotNull java.io.InputStream stream)

Reads a ResourcePack from a given InputStream.

Note that this method WILL NOT close the given stream.

Parameters:

stream - The input stream

Returns:

The read resource pack

Since:

1.3.0

readFromDirectory

default team.unnamed.creative.ResourcePack readFromDirectory(java.io.File directory)