gnu.inet.imap

Interface LiteralFactory

public interface LiteralFactory

Interface defining a mechanism that can handle large IMAP literals. These may require a significant time to load from the network, so any application that wishes to provide a progress bar, or some strategy that can cache the data on disk instead of it all being held in memory should implement this interface and call IMAPConnection#setLiteralHandler with the size threshold before IMAPConnection.connect().

Since:

1.2

Method Summary

Methods

Modifier and Type	Method and Description
Literal	newLiteral(int size) Returns a new literal of the specified size.

Method Detail

newLiteral

Literal newLiteral(int size)
                   throws java.io.IOException

Returns a new literal of the specified size.

Parameters:

size - the number of bytes that are required to store the literal

Throws:

java.io.IOException - if the handler cannot store a literal of this size