team.unnamed.creative.serialize.minecraft.fs

Interface FileTreeWriter

All Superinterfaces:

java.lang.AutoCloseable

public interface FileTreeWriter
extends java.lang.AutoCloseable

Represents a file tree, which may be implemented by a real file system with real files, or ZIP files

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
void	close() Closes this file tree, necessary for virtual file trees in a single file, like a ZIP file tree
static FileTreeWriter	directory(java.io.File root) Creates a new FileTreeWriter instance for the given File folder, all files will be written inside it
static FileTreeWriter	directory(java.io.File root, boolean clear) Creates a new FileTreeWriter instance for the given File folder, all files will be written inside it
boolean	exists(java.lang.String path) Determines if a file exists in this file tree
default void	finish() Finishes writing the file tree without closing the underlying resource, if any
default com.google.gson.stream.JsonWriter	openJsonWriter(java.lang.String path) Deprecated.
java.io.OutputStream	openStream(java.lang.String path) Opens the file at the given path and starts to write it
default java.io.Writer	openWriter(java.lang.String path) Opens the file at the given path and starts to write it using the Writer class, which is used for character streams
void	write(java.lang.String path, team.unnamed.creative.base.Writable data) Opens and writes the given data to the specified file path
static FileTreeWriter	zip(java.util.zip.ZipOutputStream zipStream) Creates a new FileTreeWriter instance for the given ZipOutputStream, will not be closed
static FileTreeWriter	zip(java.util.zip.ZipOutputStream zipStream, java.util.function.Function<java.lang.String,java.util.zip.ZipEntry> entryFactory) Deprecated. Use zip(ZipOutputStream, ZipEntryLifecycleHandler) instead
static FileTreeWriter	zip(java.util.zip.ZipOutputStream zipStream, ZipEntryLifecycleHandler entryLifecycleHandler) Creates a new FileTreeWriter instance for the given ZipOutputStream, will not be closed

Method Detail

exists

boolean exists(java.lang.String path)

Determines if a file exists in this file tree

Parameters:

path - The file path

Returns:

True if it exists

Since:

1.0.0

openStream

java.io.OutputStream openStream(java.lang.String path)

Opens the file at the given path and starts to write it

Parameters:

path - The file path

Returns:

A new OutputStream for the given file

Since:

1.0.0

openWriter

default java.io.Writer openWriter(java.lang.String path)

Opens the file at the given path and starts to write it using the Writer class, which is used for character streams

Parameters:

path - The file path

Returns:

A new Writer for the given file

Since:

1.0.0

openJsonWriter

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
default com.google.gson.stream.JsonWriter openJsonWriter(java.lang.String path)

Deprecated.

write

void write(java.lang.String path,
           team.unnamed.creative.base.Writable data)

Opens and writes the given data to the specified file path

Parameters:

path - The file path

data - The file data

Since:

1.0.0

finish

default void finish()

Finishes writing the file tree without closing the underlying resource, if any

Since:

1.0.0

close

void close()

Closes this file tree, necessary for virtual file trees in a single file, like a ZIP file tree

Specified by:

close in interface java.lang.AutoCloseable

Since:

1.0.0

directory

static FileTreeWriter directory(java.io.File root,
                                boolean clear)

Creates a new FileTreeWriter instance for the given File folder, all files will be written inside it

Will delete all the contents of the root folder if clear is set to true

Parameters:

root - The root folder

clear - True to delete the folder contents

Returns:

The created file tree for the given folder

directory

static FileTreeWriter directory(java.io.File root)

Creates a new FileTreeWriter instance for the given File folder, all files will be written inside it

Will delete all the contents of the root folder

Parameters:

root - The root folder

Returns:

The created file tree for the given folder

zip

static FileTreeWriter zip(java.util.zip.ZipOutputStream zipStream,
                          ZipEntryLifecycleHandler entryLifecycleHandler)

Creates a new FileTreeWriter instance for the given ZipOutputStream, will not be closed

Note that the created file tree will never close the given output stream, but it may be finished (ZipOutputStream.finish())

Parameters:

zipStream - The underlying zip stream

entryLifecycleHandler - The ZIP archive entry lifecycle handler

Returns:

The file tree for the given zip output stream

zip

@Deprecated
static FileTreeWriter zip(java.util.zip.ZipOutputStream zipStream,
                                       java.util.function.Function<java.lang.String,java.util.zip.ZipEntry> entryFactory)

Deprecated. Use zip(ZipOutputStream, ZipEntryLifecycleHandler) instead

Creates a new FileTreeWriter instance for the given ZipOutputStream, will not be closed

Note that the created file tree will never close the given output stream, but it may be finished (ZipOutputStream.finish())

Parameters:

zipStream - The underlying zip stream

entryFactory - The ZIP archive entry factory

Returns:

The file tree for the given zip output stream

zip

static FileTreeWriter zip(java.util.zip.ZipOutputStream zipStream)

Creates a new FileTreeWriter instance for the given ZipOutputStream, will not be closed

Note that the created file tree will never close the given output stream, but it may be finished (ZipOutputStream.finish())

Parameters:

zipStream - The underlying zip stream

Returns:

The file tree for the given zip output stream