org.apache.james.imap.api.message

Class IdRange

java.lang.Object

org.apache.james.imap.api.message.IdRange

All Implemented Interfaces:

Comparable<IdRange>, Iterable<Long>

public final class IdRange
extends Object
implements Iterable<Long>, Comparable<IdRange>

Represents a range of UID or MSN values.

Constructor Summary

Constructors

Constructor and Description
IdRange(long singleVal)
IdRange(long lowVal, long highVal)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(IdRange range2)
boolean	equals(Object obj)
String	getFormattedString()
long	getHighVal()
long	getLowVal()
int	hashCode()
boolean	includes(long value) Return true if the IdRange includes the given value
Iterator<Long>	iterator() Return a read-only Iterator which contains all msn/uid which fail in the specified range.
static List<IdRange>	mergeRanges(List<IdRange> ranges) Utility method which will copy the given List and try to merge the IdRange in the copy before return it.
void	setHighVal(long highVal)
void	setLowVal(long lowVal)
String	toString() Renders text suitable for logging.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdRange

public IdRange(long singleVal)

IdRange

public IdRange(long lowVal,
       long highVal)

Method Detail

getLowVal

public long getLowVal()

getHighVal

public long getHighVal()

setLowVal

public void setLowVal(long lowVal)

setHighVal

public void setHighVal(long highVal)

includes

public boolean includes(long value)

Return true if the IdRange includes the given value

Parameters:

value -

Returns:

include

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()

Renders text suitable for logging.

Overrides:

toString in class Object

Returns:

a String representation of this object.

getFormattedString

public String getFormattedString()

mergeRanges

public static List<IdRange> mergeRanges(List<IdRange> ranges)

Utility method which will copy the given List and try to merge the IdRange in the copy before return it.

Parameters:

ranges -

Returns:

mergedRanges

iterator

public Iterator<Long> iterator()

Return a read-only Iterator which contains all msn/uid which fail in the specified range.

Specified by:

iterator in interface Iterable<Long>

Returns:

rangeIt

compareTo

public int compareTo(IdRange range2)

Specified by:

compareTo in interface Comparable<IdRange>