team.unnamed.creative.base

Interface Writable

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Writable

Interface for representing objects that can be written to a OutputStream, this class is util for representing assets that can be exported anytime, without necessarily loading them

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BUFFER_LENGTH Determines the default buffer size used when copying data from an input stream to an output stream
static Writable	EMPTY

Method Summary

Modifier and Type	Method and Description
static @NotNull Writable	bytes(byte[] bytes) Creates a new Writable instance representing the given byte array, which is written using the OutputStream.write(byte[])} method
static @NotNull Writable	copyInputStream(@NotNull java.io.InputStream inputStream) Creates a new Writable instance that represents the given InputStream data, in order to preserve the data, it reads the input stream to a byte array when this method is called
static @NotNull Writable	file(@NotNull java.io.File file) Creates a new Writable instance that represents the given File, which will be copied to the given OutputStream when calling write(java.io.OutputStream)
static @NotNull Writable	inputStream(@NotNull java.util.concurrent.Callable<java.io.InputStream> inputStreamSupplier) Creates a new Writable instance that represents the given InputStream supplier, the supplied input stream will be opened, read and copied every time it is required
static @NotNull Writable	path(@NotNull java.nio.file.Path path, java.nio.file.OpenOption... options) Creates a new Writable instance that represents the given Path, which will be copied to the given OutputStream when calling write(java.io.OutputStream)
static @NotNull Writable	resource(@NotNull java.lang.ClassLoader loader, @NotNull java.lang.String name) Creates a new Writable instance that represents the named resource at the specified class loader
static @NotNull Writable	resource(@NotNull java.lang.String name) Deprecated. Use resource(ClassLoader, String) instead
static @NotNull Writable	stringUtf8(@NotNull java.lang.String string) Creates a new Writable instance representing the given string, which is written using the UTF-8 StandardCharsets.UTF_8 encoding
default byte[]	toByteArray() Converts this Writable instance to a byte array, it is not recommended invoking this method so often
default @NotNull java.lang.String	toUTF8String() Converts this Writable instance to an UTF-8 string, it is not recommended invoking this method so often, it exists only for easing debugging
void	write(@NotNull java.io.OutputStream output) Writes this object information to a OutputStream, this method can be called anytime, it should be consistent with its data and generate the exact same output for the same input (attributes) of the implementation

Field Detail

EMPTY

static final Writable EMPTY

DEFAULT_BUFFER_LENGTH

static final int DEFAULT_BUFFER_LENGTH

Determines the default buffer size used when copying data from an input stream to an output stream

See Also:

Constant Field Values

Method Detail

write

void write(@NotNull
           @NotNull java.io.OutputStream output)
    throws java.io.IOException

Writes this object information to a OutputStream, this method can be called anytime, it should be consistent with its data and generate the exact same output for the same input (attributes) of the implementation

Parameters:

output - The target output stream

Throws:

java.io.IOException - If write fails

Since:

1.0.0

toByteArray

default byte[] toByteArray()
                    throws java.io.IOException

Converts this Writable instance to a byte array, it is not recommended invoking this method so often

Returns:

This writable instance as a byte array

Throws:

java.io.IOException - If conversion fails

toUTF8String

@NotNull
default @NotNull java.lang.String toUTF8String()
                                                  throws java.io.IOException

Converts this Writable instance to an UTF-8 string, it is not recommended invoking this method so often, it exists only for easing debugging

Returns:

This writable instance as an UTF-8 string

Throws:

java.io.IOException - If conversion fails

resource

@NotNull
static @NotNull Writable resource(@NotNull
                                            @NotNull java.lang.ClassLoader loader,
                                            @NotNull
                                            @NotNull java.lang.String name)

Creates a new Writable instance that represents the named resource at the specified class loader

Parameters:

loader - The class loader that holds the resource

name - The full resource name

Returns:

The Writable representation

Since:

1.0.0

resource

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="2.0.0")
 @NotNull
static @NotNull Writable resource(@NotNull
                                                                                                              @NotNull java.lang.String name)

Deprecated. Use resource(ClassLoader, String) instead

Creates a new Writable instance that represents the named resource at the caller class loader.

Parameters:

name - The full resource name

Returns:

The Writable representation

Since:

1.1.0

file

@NotNull
static @NotNull Writable file(@NotNull
                                        @NotNull java.io.File file)

Creates a new Writable instance that represents the given File, which will be copied to the given OutputStream when calling write(java.io.OutputStream)

Parameters:

file - The wrapped file, must exist

Returns:

The Writable representation for this file

Since:

1.0.0

path

@NotNull
static @NotNull Writable path(@NotNull
                                        @NotNull java.nio.file.Path path,
                                        @NotNull
                                        java.nio.file.OpenOption... options)

Creates a new Writable instance that represents the given Path, which will be copied to the given OutputStream when calling write(java.io.OutputStream)

Parameters:

path - The file path

options - The options (Files.newInputStream(java.nio.file.Path, java.nio.file.OpenOption...))

Returns:

The Writable representation for this path

Since:

1.0.0

inputStream

@NotNull
static @NotNull Writable inputStream(@NotNull
                                               @NotNull java.util.concurrent.Callable<java.io.InputStream> inputStreamSupplier)

Creates a new Writable instance that represents the given InputStream supplier, the supplied input stream will be opened, read and copied every time it is required

Parameters:

inputStreamSupplier - The input stream supplier

Returns:

The Writable representation

Since:

1.0.0

copyInputStream

@NotNull
static @NotNull Writable copyInputStream(@NotNull
                                                   @NotNull java.io.InputStream inputStream)
                                            throws java.io.IOException

Creates a new Writable instance that represents the given InputStream data, in order to preserve the data, it reads the input stream to a byte array when this method is called

Parameters:

inputStream - The input stream to copy

Returns:

The Writable representation

Throws:

java.io.IOException - If reading the input stream fails

Since:

1.0.0

bytes

@NotNull
static @NotNull Writable bytes(byte[] bytes)

Creates a new Writable instance representing the given byte array, which is written using the OutputStream.write(byte[])} method

Parameters:

bytes - The wrapped bytes

Returns:

The Writable representation

Since:

1.0.0

stringUtf8

@NotNull
static @NotNull Writable stringUtf8(@NotNull
                                              @NotNull java.lang.String string)

Creates a new Writable instance representing the given string, which is written using the UTF-8 StandardCharsets.UTF_8 encoding

Parameters:

string - The wrapped string

Returns:

The Writable representation

Since:

1.0.0