FoldersPayload

public class FoldersPayload extends NamedPayloads

A folders payload represent a folder hierarchical with the set of payloads. Creation Date: 5/10/2006

Author:Twinsen Tsang

Constructors

FoldersPayload

protected FoldersPayload(String payloadsName, int initialState, PayloadsRepository owner)

Protected Explicit Constructor. This constructor is mainly used for creating a new payload proxy including the physical file and the proxy object.

Parameters:
  • payloadsName – The name of the newly created payload.
  • initialState – The initialState of the payloads, see PayloadsState for details.
  • owner – The owner of the payloads.
Throws:
  • Exception – Any kind of exceptions.

FoldersPayload

protected FoldersPayload(File payloads, PayloadsRepository owner)

Protected Explicit Constructor.

Parameters:
  • payloads – The payloads directory.
  • owner – The owner of this payload.
Throws:
  • IOException – If the payload is not directory.

Methods

clearPayloadCache

public void clearPayloadCache()

Clear all the content and the folder for this payload.

decode

protected void decode()

Decode the payload root to become some useful information. Only the partnershipId (the first token) is assigned.

Throws:

encode

protected void encode()

getMessageId

public String getMessageId()
Returns:the message of the payloads.

getNumOfFiles

public int getNumOfFiles()
Returns:the number of files within the folders.

getPartnershipId

public String getPartnershipId()
Returns:the partnership id of the payloads.

getSize

public long getSize()
Returns:the total size within the folders.

load

public InputStream load()

The outgoing payload does not support load method.

loadChannel

public ReadableByteChannel loadChannel()

The outgoing payload does not support loadChannel method.

save

public void save(InputStream content, boolean append)

The outgoing payload does not support save method.

toString

public String toString()

toString method