Module com.aoapps.messaging.api

Package com.aoapps.messaging

Class FileMessage

java.lang.Object

com.aoapps.messaging.FileMessage

All Implemented Interfaces:

Message, Closeable, AutoCloseable

public class FileMessage
extends Object
implements Message

A message that is a file.

Constructor Summary

Constructors

Constructor	Description
FileMessage(File file)	Creates a new FileMessage.

Method Summary

Modifier and Type	Method	Description
void	close()	The message should be closed when it is no longer needed.
static FileMessage	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.
static FileMessage	decode(ByteArray encodedMessage, File file)	Restores this message into the provided file.
static FileMessage	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.
static FileMessage	decode(String encodedMessage, File file)	Base-64 decodes the message into the provided file.
ByteArray	encodeAsByteArray()	Gets a binary representation of this message.
String	encodeAsString()	Base-64 encodes the message.
boolean	equals(Object o)	Two messages of the same type with the same body must be considered equal.
File	getMessage()
MessageType	getMessageType()	Gets the message type.
int	hashCode()	The hash code must be consistent with equals.
boolean	isTemp()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

FileMessage

public FileMessage(File file)

Creates a new FileMessage.

Method Details

decode

public static FileMessage decode(String encodedMessage,
 File file)
                          throws IOException

Base-64 decodes the message into the provided file.

Throws:

IOException

See Also:

• decode(com.aoapps.messaging.ByteArray, java.io.File)

decode

@Deprecated(forRemoval=true)
public static FileMessage 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.

Base-64 decodes the message into a temp file.

Throws:

IOException

See Also:

• decode(java.lang.String, java.io.File)

decode

public static FileMessage decode(ByteArray encodedMessage,
 File file)
                          throws IOException

Restores this message into the provided file.

Throws:

IOException

See Also:

• decode(java.lang.String, java.io.File)

decode

@Deprecated(forRemoval=true)
public static FileMessage 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.

Restores this message into a temp file.

Throws:

IOException

See Also:

• decode(com.aoapps.messaging.ByteArray, java.io.File)

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

Base-64 encodes the message.

Specified by:

encodeAsString in interface Message

Throws:

IOException

encodeAsByteArray

public ByteArray encodeAsByteArray()
                            throws IOException

Description copied from interface: Message

Gets a binary representation of this message.

Specified by:

encodeAsByteArray in interface Message

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: Message

The message should be closed when it is no longer needed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Message

Throws:

IOException

isTemp

public boolean isTemp()

getMessage

public File getMessage()