ml.karmaconfigs.remote.messaging.util.message

Class MessageOutput

java.lang.Object

ml.karmaconfigs.remote.messaging.util.message.MessageOutput

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MessageDataOutput

public abstract class MessageOutput
extends Object
implements Serializable

Message input interface

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MessageOutput() Initialize the message input
MessageOutput(byte[] merge, MergeType mt) Initialize the message input
MessageOutput(@Nullable MessageOutput merge, MergeType mt) Initialize the message input

Method Summary

Modifier and Type	Method and Description
abstract byte[]	compile() Compile the message input
abstract boolean	contains(String key, DataType type) Get if the message input contains the specified key in the specified data type
abstract Set<String>	getKeys(DataType type) Get all the data keys for the specified data type
abstract void	remove(String key, DataType type) Remove data from the specified type
abstract <T> void	unsafeWrite(String key, T data, DataType type) Write unsafely to the message input
abstract void	write(String key, boolean data) Write data to the message input
abstract void	write(String key, byte[] data) Write data to the message input
abstract void	write(String key, char... chars) Write data to the message input
abstract void	write(String key, CharSequence data) Write data to the message input
abstract void	write(String key, Number number) Write data to the message input
abstract void	writeSerializable(String key, Serializable data) Write data to the message input

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageOutput

public MessageOutput()

Initialize the message input

MessageOutput

public MessageOutput(@Nullable
                     @Nullable MessageOutput merge,
                     MergeType mt)

Initialize the message input

Parameters:

merge - the already existing message input

mt - the merge type for the already existing message input

MessageOutput

public MessageOutput(byte[] merge,
                     MergeType mt)

Initialize the message input

Parameters:

merge - the already existing message input

mt - the merge type for the already existing message input

Method Detail

writeSerializable

public abstract void writeSerializable(String key,
                                       Serializable data)

Write data to the message input

Parameters:

key - the data key

data - the data to write

write

public abstract void write(String key,
                           CharSequence data)

Write data to the message input

Parameters:

key - the data key

data - the data ( character sequence ) to write

write

public abstract void write(String key,
                           boolean data)

Write data to the message input

Parameters:

key - the data key

data - the data ( boolean ) to write

write

public abstract void write(String key,
                           Number number)

Write data to the message input

Parameters:

key - the data key

number - the data ( number ) to write

write

public abstract void write(String key,
                           char... chars)

Write data to the message input

Parameters:

key - the data key

chars - the data ( characters ) to write

write

public abstract void write(String key,
                           byte[] data)

Write data to the message input

Parameters:

key - the data key

data - the data ( bytes ) to write

unsafeWrite

public abstract <T> void unsafeWrite(String key,
                                     T data,
                                     DataType type)

Write unsafely to the message input

Type Parameters:

T - the data type

Parameters:

key - the data key

data - the data to write

type - the data type

remove

public abstract void remove(String key,
                            DataType type)

Remove data from the specified type

Parameters:

key - the data key

type - the data type

getKeys

public abstract Set<String> getKeys(DataType type)

Get all the data keys for the specified data type

Parameters:

type - the data type

Returns:

all the keys

contains

public abstract boolean contains(String key,
                                 DataType type)

Get if the message input contains the specified key in the specified data type

Parameters:

key - the data key

type - the data type

Returns:

if the message input contains that data

compile

public abstract byte[] compile()

Compile the message input

Returns:

the message input