Top Description Fields Constructors Methods
com.sun.mail.imap.protocol

public Class UIDSet

extends Object
Class Inheritance
Imports
java.util.List, .ArrayList, .StringTokenizer
This class holds the 'start' and 'end' for a range of UIDs. Just like MessageSet except using long instead of int.

Field Summary

Modifier and TypeField and Description
public long
end

public long
start

Constructor Summary

AccessConstructor and Description
public
UIDSet()

public
UIDSet(long start, long end)

Method Summary

Modifier and TypeMethod and Description
public static UIDSet[]

Returns:

array of UIDSet objects
createUIDSets(long[]
the UIDs
uids)

Convert an array of longs into an array of UIDSets

public static UIDSet[]

Returns:

array of UIDSet objects
parseUIDSets(String
UID string
uids)

Parse a string in IMAP UID range format.

public long

Returns:

the number of elements
size()

Count the total number of elements in a UIDSet

public static long

Returns:

the number of elements
size(UIDSet[]
the UIDSets
uidset)

Count the total number of elements in an array of UIDSets.

private static long
size(UIDSet[] uidset, long uidmax)

Count the total number of elements in an array of UIDSets.

public static long[]

Returns:

arrray of UIDs
toArray(UIDSet[]
the UIDSets
uidset)

Convert an array of UIDSets into a array of long UIDs.

public static long[]

Returns:

arrray of UIDs
toArray(UIDSet[]
the UIDSets
uidset, long
maximum UID
uidmax)

Convert an array of UIDSets into a array of long UIDs.

public static String

Returns:

the IMAP sequence string
toString(UIDSet[]
the UIDSets
uidset)

Convert an array of UIDSets into an IMAP sequence range.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

endback to summary
public long end
startback to summary
public long start

Constructor Detail

UIDSetback to summary
public UIDSet()
UIDSetback to summary
public UIDSet(long start, long end)

Method Detail

createUIDSetsback to summary
public static UIDSet[] createUIDSets(long[] uids)

Convert an array of longs into an array of UIDSets

Parameters
uids:long[]

the UIDs

Returns:UIDSet[]

array of UIDSet objects

parseUIDSetsback to summary
public static UIDSet[] parseUIDSets(String uids)

Parse a string in IMAP UID range format.

Parameters
uids:String

UID string

Returns:UIDSet[]

array of UIDSet objects

Since
JavaMail 1.5.1
sizeback to summary
public long size()

Count the total number of elements in a UIDSet

Returns:long

the number of elements

sizeback to summary
public static long size(UIDSet[] uidset)

Count the total number of elements in an array of UIDSets.

Parameters
uidset:UIDSet[]

the UIDSets

Returns:long

the number of elements

sizeback to summary
private static long size(UIDSet[] uidset, long uidmax)

Count the total number of elements in an array of UIDSets. Don't count UIDs greater then uidmax.

Since
JavaMail 1.5.1
toArrayback to summary
public static long[] toArray(UIDSet[] uidset)

Convert an array of UIDSets into a array of long UIDs.

Parameters
uidset:UIDSet[]

the UIDSets

Returns:long[]

arrray of UIDs

Since
JavaMail 1.5.1
toArrayback to summary
public static long[] toArray(UIDSet[] uidset, long uidmax)

Convert an array of UIDSets into a array of long UIDs. Don't include any UIDs larger than uidmax.

Parameters
uidset:UIDSet[]

the UIDSets

uidmax:long

maximum UID

Returns:long[]

arrray of UIDs

Since
JavaMail 1.5.1
toStringback to summary
public static String toString(UIDSet[] uidset)

Convert an array of UIDSets into an IMAP sequence range.

Parameters
uidset:UIDSet[]

the UIDSets

Returns:String

the IMAP sequence string