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

public abstract Class FetchItem

extends Object
Class Inheritance
Imports
java.lang.reflect.*, javax.mail.FetchProfile, com.sun.mail.iap.ParsingException
Metadata describing a FETCH item. Note that the "name" field MUST be in uppercase.

Author
Bill Shannon
Since
JavaMail 1.4.6

Field Summary

Modifier and TypeField and Description
private FetchProfile.Item
fetchProfileItem

private String
name

Constructor Summary

AccessConstructor and Description
public
FetchItem(String name, FetchProfile.Item fetchProfileItem)

Method Summary

Modifier and TypeMethod and Description
public FetchProfile.Item
getFetchProfileItem()

public String
getName()

public abstract Object

Returns:

the fetch item
parseItem(FetchResponse
the response
r)

Parse the item into some kind of object appropriate for the item.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

fetchProfileItemback to summary
private FetchProfile.Item fetchProfileItem
nameback to summary
private String name

Constructor Detail

FetchItemback to summary
public FetchItem(String name, FetchProfile.Item fetchProfileItem)

Method Detail

getFetchProfileItemback to summary
public FetchProfile.Item getFetchProfileItem()
getNameback to summary
public String getName()
parseItemback to summary
public abstract Object parseItem(FetchResponse r) throws ParsingException

Parse the item into some kind of object appropriate for the item. Note that the item name will have been parsed and skipped already.

Parameters
r:FetchResponse

the response

Returns:Object

the fetch item

Exceptions
ParsingException:
for parsing failures