team.unnamed.creative.serialize.minecraft.fs

Interface FileTreeReader

All Superinterfaces:

java.lang.AutoCloseable

public interface FileTreeReader
extends java.lang.AutoCloseable

Method Summary

Modifier and Type	Method and Description
void	close()
default @NotNull team.unnamed.creative.base.Readable	content() Returns the current entry's data as a Readable.
static FileTreeReader	directory(java.io.File root)
boolean	hasNext()
default @NotNull java.io.InputStream	input() Deprecated. Use stream() instead
java.lang.String	next()
@NotNull java.io.InputStream	stream() Returns the current entry's data as an input stream.
static @NotNull FileTreeReader	zip(@NotNull java.util.zip.ZipFile zipFile) Creates a new FileTreeReader from the given ZipFile.
static FileTreeReader	zip(java.util.zip.ZipInputStream zip)

Method Detail

hasNext

boolean hasNext()

next

java.lang.String next()

stream

@NotNull
@NotNull java.io.InputStream stream()

Returns the current entry's data as an input stream.

The returned input stream has a short lifetime and will be closed when next() is called again.

To store any content of the entry use the content() method.

Returns:

The current entry's data as an input stream

Since:

1.3.0

content

@NotNull
default @NotNull team.unnamed.creative.base.Readable content()

Returns the current entry's data as a Readable.

The returned readable instance can be used to store the entry's content.

Returns:

The current entry's data as a readable

Since:

1.3.0

input

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
default @NotNull java.io.InputStream input()

Deprecated. Use stream() instead

Returns the current entry's data as an input stream.

The returned input stream has a short lifetime and will be closed when next() is called again.

To store any content of the entry use the content() method.

Returns:

The current entry's data as an input stream

Since:

1.0.0

close

void close()
    throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

zip

static FileTreeReader zip(java.util.zip.ZipInputStream zip)

zip

@NotNull
static @NotNull FileTreeReader zip(@NotNull
                                             @NotNull java.util.zip.ZipFile zipFile)

Creates a new FileTreeReader from the given ZipFile.

Parameters:

zipFile - The zip file to read

Returns:

The created file tree reader

Since:

1.3.0

directory

static FileTreeReader directory(java.io.File root)