org.apache.james.imap.message.response

Class SearchResponse

java.lang.Object

org.apache.james.imap.message.response.SearchResponse

All Implemented Interfaces:

ImapMessage, ImapResponseMessage

public class SearchResponse
extends Object
implements ImapResponseMessage

A SEARCH response.

Constructor Summary

Constructors

Constructor and Description
SearchResponse(long[] ids, Long highestModSeq) Constructs a SEARCH response.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Long	getHighestModSeq() Return the highest mod-sequence for which matched the search.
long[]	getIds() Gets the ids returned by this search.
int	hashCode()
String	toString() Constructs a String with all attributes in name = value format.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResponse

public SearchResponse(long[] ids,
              Long highestModSeq)

Constructs a SEARCH response.

Parameters:

ids - ids, not null

highestModSeq -

Method Detail

getIds

public final long[] getIds()

Gets the ids returned by this search.

Returns:

the ids, not null

getHighestModSeq

public final Long getHighestModSeq()

Return the highest mod-sequence for which matched the search. This is only set if the search included the MODSEQ parameter

Returns:

highestMod

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Constructs a String with all attributes in name = value format.

Overrides:

toString in class Object

Returns:

a String representation of this object.