com.comphenix.protocol.utility

Class StreamSerializer

java.lang.Object

com.comphenix.protocol.utility.StreamSerializer

public class StreamSerializer
extends java.lang.Object

Utility methods for reading and writing Minecraft objects to streams.

Author:

Kristian

Constructor Summary

Constructors

Constructor and Description
StreamSerializer()

Method Summary

Methods

Modifier and Type	Method and Description
ItemStack	deserializeItemStack(java.io.DataInputStream input) Read or deserialize an item stack from an underlying input stream.
ItemStack	deserializeItemStack(java.lang.String input) Deserialize an item stack from a base-64 encoded string.
void	serializeItemStack(java.io.DataOutputStream output, ItemStack stack) Write or serialize an item stack to the given output stream.
java.lang.String	serializeItemStack(ItemStack stack) Serialize an item stack as a base-64 encoded string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StreamSerializer

public StreamSerializer()

Method Detail

deserializeItemStack

public ItemStack deserializeItemStack(@Nonnull
                             java.io.DataInputStream input)
                               throws java.io.IOException

Read or deserialize an item stack from an underlying input stream.

To supply a byte array, wrap it in a ByteArrayInputStream and DataInputStream.

Parameters:

input - - the target input stream.

Returns:

The resulting item stack, or NULL if the serialized item stack was NULL.

Throws:

java.io.IOException - If the operation failed due to reflection or corrupt data.

deserializeItemStack

public ItemStack deserializeItemStack(@Nonnull
                             java.lang.String input)
                               throws java.io.IOException

Deserialize an item stack from a base-64 encoded string.

Parameters:

input - - base-64 encoded string.

Returns:

A deserialized item stack, or NULL if the serialized ItemStack was also NULL.

Throws:

java.io.IOException - If the operation failed due to reflection or corrupt data.

serializeItemStack

public void serializeItemStack(@Nonnull
                      java.io.DataOutputStream output,
                      ItemStack stack)
                        throws java.io.IOException

Write or serialize an item stack to the given output stream.

To supply a byte array, wrap it in a ByteArrayOutputStream and DataOutputStream.

Note: An ItemStack can be written to a stream even if it's NULL.

Parameters:

output - - the target output stream.

stack - - the item stack that will be written, or NULL to represent air/nothing.

Throws:

java.io.IOException - If the operation fails due to reflection problems.

serializeItemStack

public java.lang.String serializeItemStack(ItemStack stack)
                                    throws java.io.IOException

Serialize an item stack as a base-64 encoded string.

Note: An ItemStack can be written to the serialized text even if it's NULL.

Parameters:

stack - - the item stack to serialize, or NULL to represent air/nothing.

Returns:

A base-64 representation of the given item stack.

Throws:

java.io.IOException - If the operation fails due to reflection problems.