Module com.aoapps.messaging.api

Package com.aoapps.messaging

Enum MessageType

java.lang.Object

java.lang.Enum<MessageType>

com.aoapps.messaging.MessageType

All Implemented Interfaces:

Serializable, Comparable<MessageType>

public enum MessageType
extends Enum<MessageType>

The types of serializations.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BYTE_ARRAY
FILE
MULTI
STRING

Method Summary

Modifier and Type	Method	Description
abstract Message	decode(ByteArray encodedMessage)	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.
abstract Message	decode(ByteArray encodedMessage, IOSupplier<TempFileContext> tempFileContextSupplier)	Constructs a message of this type from its byte array encoding using the provided temporary file context supplier as-needed.
final Message	decode(ByteArray encodedMessage, TempFileContext tempFileContext)	Deprecated. Please use TempFileContext supplier which may defer creation until first needed.
abstract Message	decode(String encodedMessage)	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.
abstract Message	decode(String encodedMessage, IOSupplier<TempFileContext> tempFileContextSupplier)	Constructs a message of this type from its string encoding using the provided temporary file context supplier as-needed.
final Message	decode(String encodedMessage, TempFileContext tempFileContext)	Deprecated. Please use TempFileContext supplier which may defer creation until first needed.
static MessageType	getFromTypeByte(byte typeByte)	Gets the message type for its numeric code.
static MessageType	getFromTypeChar(char typeChar)	Gets the message type for its character code.
abstract byte	getTypeByte()	Gets the single byte that uniquely represents this message type.
abstract char	getTypeChar()	Gets the single character that uniquely represents this message type.
static MessageType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MessageType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BYTE_ARRAY

public static final MessageType BYTE_ARRAY

FILE

public static final MessageType FILE

STRING

public static final MessageType STRING

MULTI

public static final MessageType MULTI

Method Details

values

public static MessageType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MessageType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getFromTypeByte

public static MessageType getFromTypeByte(byte typeByte)

Gets the message type for its numeric code.

getFromTypeChar

public static MessageType getFromTypeChar(char typeChar)

Gets the message type for its character code.

getTypeByte

public abstract byte getTypeByte()

Gets the single byte that uniquely represents this message type.

getTypeChar

public abstract char getTypeChar()

Gets the single character that uniquely represents this message type.

decode

public abstract Message decode(String encodedMessage,
 IOSupplier<TempFileContext> tempFileContextSupplier)
                        throws IOException

Constructs a message of this type from its string encoding using the provided temporary file context supplier as-needed.

Throws:

IOException

decode

public final Message decode(String encodedMessage,
 TempFileContext tempFileContext)
                     throws IOException

Deprecated.

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

Constructs a message of this type from its string encoding 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 abstract Message decode(String encodedMessage)
                        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.

Constructs a message of this type from its string encoding, 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 abstract Message decode(ByteArray encodedMessage,
 IOSupplier<TempFileContext> tempFileContextSupplier)
                        throws IOException

Constructs a message of this type from its byte array encoding using the provided temporary file context supplier as-needed.

Throws:

IOException

decode

public final Message decode(ByteArray encodedMessage,
 TempFileContext tempFileContext)
                     throws IOException

Deprecated.

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

Constructs a message of this type from its byte array encoding 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 abstract Message decode(ByteArray encodedMessage)
                        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.

Constructs a message of this type from its byte array encoding, possibly using temporary files with File.deleteOnExit() as-needed.

Throws:

IOException

See Also:

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