net.fortuna.mstor
Interface MetaFolder

All Known Implementing Classes:

MetaFolderImpl

public interface MetaFolder

Defines a set of metadata for an mstor folder.

Author:

benfortuna

Method Summary

void	addMessage(MetaMessage message) Adds the specified message metadata.
MetaMessage	getMessage(Message message) Returns message metadata corresponding to the specified message id.
String	getName()
MetaMessage	removeMessage(int messageNumber) Removes the message metadata corresponding to the specified message number.
MetaMessage[]	removeMessages(int[] messageNumber) Removes the message metadata corresponding to the specified message numbers.
void	save() Saves the meta data to the filesystem.
void	setName(String name)

Method Detail

getName

String getName()

Returns:

Returns the name.

setName

void setName(String name)

Parameters:

name - The name to set.

getMessage

MetaMessage getMessage(Message message)

Returns message metadata corresponding to the specified message id. If no metadata exists a new MetaMessage is created.

Parameters:

messageId -

Returns:

addMessage

void addMessage(MetaMessage message)

Adds the specified message metadata.

Parameters:

message -

removeMessage

MetaMessage removeMessage(int messageNumber)

Removes the message metadata corresponding to the specified message number.

Parameters:

messageNumber - the number of the message metadata to remove

Returns:

the removed message metadata

removeMessages

MetaMessage[] removeMessages(int[] messageNumber)

Removes the message metadata corresponding to the specified message numbers.

Parameters:

messageNumbers - an array of numbers of the message metadata to remove

Returns:

an array of the removed message metadata

save

void save()
          throws IOException

Saves the meta data to the filesystem.

Throws:

IOException