SK.gnome.dwarf.mail.store.search
Class SequenceKey

java.lang.Object
  SK.gnome.dwarf.mail.store.search.SearchKey
      SK.gnome.dwarf.mail.store.search.SequenceKey

public class SequenceKey

extends SearchKey

This key matches the given sequence set and the actual message number or UID.

Field Summary

protected SequenceSet

sequence The matched sequence set.

Fields inherited from class SK.gnome.dwarf.mail.store.search.SearchKey

type

Constructor Summary

SequenceKey(SequenceSet sequence)
Creates a new SequenceKey.

Method Summary

SequenceSet	getSequenceSet() Returns the matched sequence set.
boolean	match(MailMessage message) Matches the given sequence set and the actual message number or UID.
java.lang.String	toString() Returns the string represenation of the key.

Methods inherited from class SK.gnome.dwarf.mail.store.search.SearchKey

addError, clearErrors, getErrors, getType, hasError

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sequence

protected SequenceSet sequence

The matched sequence set.

Constructor Detail

SequenceKey

public SequenceKey(SequenceSet sequence)

Creates a new SequenceKey.

Parameters:

sequence - the matched sequence set

Method Detail

getSequenceSet

public SequenceSet getSequenceSet()

Returns the matched sequence set.

Returns:

the sequence set

match

public boolean match(MailMessage message)
              throws MailException

Matches the given sequence set and the actual message number or UID.

Specified by:

match in class SearchKey

Parameters:

message - the searched message

Returns:

true if the given key criteria and message matches, false otherwise

Throws:

MailException - if an error occurs

toString

public java.lang.String toString()

Description copied from class: SearchKey

Returns the string represenation of the key.

Overrides:

toString in class SearchKey

Returns:

the key string