Module com.aoapps.messaging.api

Package com.aoapps.messaging

Class MultiMessage

java.lang.Object

com.aoapps.messaging.MultiMessage

All Implemented Interfaces:

Message, Closeable, AutoCloseable

public class MultiMessage
extends Object
implements Message

A message that is a combination of multiple messages.

Field Summary

Fields

Modifier and Type	Field	Description
static final MultiMessage	EMPTY_MULTI_MESSAGE

Constructor Summary

Constructors

Constructor	Description
MultiMessage(Collection<? extends Message> messages)	Creates a new multi-message.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes each of the underlying messages.
static MultiMessage	decode(ByteArray encodedMessages)	Deprecated, for removal: This API element is subject to removal in a future version. Please use TempFileContext supplier since File.deleteOnExit() is prone to memory leaks in long-running applications.
static MultiMessage	decode(ByteArray encodedMessages, IOSupplier<TempFileContext> tempFileContextSupplier)	Decodes the messages using the provided temporary file context suppler as-needed.
static MultiMessage	decode(ByteArray encodedMessages, TempFileContext tempFileContext)	Deprecated. Please use TempFileContext supplier which may defer creation until first needed.
static MultiMessage	decode(String encodedMessages)	Deprecated, for removal: This API element is subject to removal in a future version. Please use TempFileContext supplier since File.deleteOnExit() is prone to memory leaks in long-running applications.
static MultiMessage	decode(String encodedMessages, IOSupplier<TempFileContext> tempFileContextSupplier)	Decodes the messages using the provided temporary file context supplier as-needed.
static MultiMessage	decode(String encodedMessages, TempFileContext tempFileContext)	Deprecated. Please use TempFileContext supplier which may defer creation until first needed.
ByteArray	encodeAsByteArray()	Encodes the messages into a single ByteArray.
String	encodeAsString()	Encodes the messages into a single string.
boolean	equals(Object o)	Two messages of the same type with the same body must be considered equal.
Collection<? extends Message>	getMessages()	Gets the messages or empty list for none.
MessageType	getMessageType()	Gets the message type.
int	hashCode()	The hash code must be consistent with equals.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EMPTY_MULTI_MESSAGE

public static final MultiMessage EMPTY_MULTI_MESSAGE

Constructor Details

MultiMessage

public MultiMessage(Collection<? extends Message> messages)

Creates a new multi-message.

Parameters:

messages - The messages or null for none, defensive copy if performed

Method Details

decode

public static MultiMessage decode(String encodedMessages,
 IOSupplier<TempFileContext> tempFileContextSupplier)
                           throws IOException

Decodes the messages using the provided temporary file context supplier as-needed.

Throws:

IOException

decode

public static MultiMessage decode(String encodedMessages,
 TempFileContext tempFileContext)
                           throws IOException

Deprecated.

Please use TempFileContext supplier which may defer creation until first needed.

Decodes the messages using the provided temporary file context as-needed.

Throws:

IOException

See Also:

• decode(java.lang.String, com.aoapps.lang.io.function.IOSupplier)

decode

@Deprecated(forRemoval=true)
public static MultiMessage decode(String encodedMessages)
                           throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Please use TempFileContext supplier since File.deleteOnExit() is prone to memory leaks in long-running applications.

Decodes the messages, possibly using temporary files with File.deleteOnExit() as-needed.

Throws:

IOException

See Also:

• decode(java.lang.String, com.aoapps.lang.io.function.IOSupplier)

decode

public static MultiMessage decode(ByteArray encodedMessages,
 IOSupplier<TempFileContext> tempFileContextSupplier)
                           throws IOException

Decodes the messages using the provided temporary file context suppler as-needed.

Throws:

IOException

decode

public static MultiMessage decode(ByteArray encodedMessages,
 TempFileContext tempFileContext)
                           throws IOException

Deprecated.

Please use TempFileContext supplier which may defer creation until first needed.

Decodes the messages using the provided temporary file context as-needed.

Throws:

IOException

See Also:

• decode(com.aoapps.messaging.ByteArray, com.aoapps.lang.io.function.IOSupplier)

decode

@Deprecated(forRemoval=true)
public static MultiMessage decode(ByteArray encodedMessages)
                           throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Please use TempFileContext supplier since File.deleteOnExit() is prone to memory leaks in long-running applications.

Decodes the messages, possibly using temporary files with File.deleteOnExit() as-needed.

Throws:

IOException

See Also:

• decode(com.aoapps.messaging.ByteArray, com.aoapps.lang.io.function.IOSupplier)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from interface: Message

Two messages of the same type with the same body must be considered equal.

Specified by:

equals in interface Message

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: Message

The hash code must be consistent with equals.

Specified by:

hashCode in interface Message

Overrides:

hashCode in class Object

getMessageType

public MessageType getMessageType()

Description copied from interface: Message

Gets the message type.

Specified by:

getMessageType in interface Message

encodeAsString

public String encodeAsString()
                      throws IOException

Encodes the messages into a single string.

Specified by:

encodeAsString in interface Message

Throws:

IOException

encodeAsByteArray

public ByteArray encodeAsByteArray()
                            throws IOException

Encodes the messages into a single ByteArray. There is likely a more efficient implementation that reads-through, but this is a simple implementation.

Specified by:

encodeAsByteArray in interface Message

Throws:

IOException

close

public void close()
           throws IOException

Closes each of the underlying messages.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Message

Throws:

IOException

getMessages

public Collection<? extends Message> getMessages()

Gets the messages or empty list for none.