org.apache.james.mailbox.model

Class MessageRange

java.lang.Object

org.apache.james.mailbox.model.MessageRange

All Implemented Interfaces:

Iterable<Long>

public class MessageRange
extends Object
implements Iterable<Long>

Used to define a range of messages by uid.
The type of the set should be defined by using an appropriate constructor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageRange.Type

Field Summary

Fields

Modifier and Type	Field and Description
static long	MAX_UID
static long	NOT_A_UID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MessageRange(MessageRange.Type type, long uidFrom, long uidTo)

Method Summary

Methods

Modifier and Type	Method and Description
static MessageRange	all() Constructs a range consisting of all messages.
static MessageRange	from(long from) Constructs an inclusive, open ended range of messages.
MessageRange.Type	getType()
long	getUidFrom()
long	getUidTo()
boolean	includes(long uid) Return true if the uid is within the range
Iterator<Long>	iterator() Return a read-only Iterator which contains all uid which fail in the specified range.
static MessageRange	one(long uid) Constructs a range consisting of a single message only.
static MessageRange	range(long from, long to) Constructs an inclusive ranges of messages.
List<MessageRange>	split(int maxItems) Tries to split the given MessageRange to a List of MessageRange's which select only a max amount of items.
static List<MessageRange>	toRanges(Collection<Long> uidsCol) Converts the given Collection of uids to a List of MessageRange instances
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NOT_A_UID

public static final long NOT_A_UID

See Also:

Constant Field Values

MAX_UID

public static final long MAX_UID

See Also:

Constant Field Values

Constructor Detail

MessageRange

protected MessageRange(MessageRange.Type type,
            long uidFrom,
            long uidTo)

Method Detail

one

public static MessageRange one(long uid)

Constructs a range consisting of a single message only.

Parameters:

uid - UID of the message

Returns:

not null

all

public static MessageRange all()

Constructs a range consisting of all messages.

Returns:

not null

range

public static MessageRange range(long from,
                 long to)

Constructs an inclusive ranges of messages. The parameters will be checked and from(long) used where appropriate.

Parameters:

from - first message UID

to - last message UID

Returns:

not null

from

public static MessageRange from(long from)

Constructs an inclusive, open ended range of messages.

Parameters:

from - first message UID in range

Returns:

not null

getType

public MessageRange.Type getType()

getUidFrom

public long getUidFrom()

getUidTo

public long getUidTo()

includes

public boolean includes(long uid)

Return true if the uid is within the range

Parameters:

uid -

Returns:

withinRange

toString

public String toString()

Overrides:

toString in class Object

toRanges

public static List<MessageRange> toRanges(Collection<Long> uidsCol)

Converts the given Collection of uids to a List of MessageRange instances

Parameters:

uidsCol - collection of uids to convert

Returns:

ranges

iterator

public Iterator<Long> iterator()

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

Specified by:

iterator in interface Iterable<Long>

Returns:

rangeIt

split

public List<MessageRange> split(int maxItems)

Tries to split the given MessageRange to a List of MessageRange's which select only a max amount of items. This only work for MessageRange's with MessageRange.Type of MessageRange.Type.RANGE.

Parameters:

maxItems -

Returns:

ranges