Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

javax.mail
Class FetchProfile  view FetchProfile download FetchProfile.java

java.lang.Object
  extended byjavax.mail.FetchProfile

public class FetchProfile
extends java.lang.Object

A FetchProfile defines a list of message attributes that a client wishes to prefetch from the server during a fetch operation. Clients can either specify individual headers, or can reference common profiles as defined by FetchProfile.Item.

Version:
$Rev: 125583 $ $Date: 2005-01-18 19:44:27 -0800 (Tue, 18 Jan 2005) $

Nested Class Summary
static class FetchProfile.Item
          Inner class that defines sets of headers that are commonly bundled together in a FetchProfile.
 
Field Summary
private  java.util.List headers
           
private  java.util.List items
           
 
Constructor Summary
FetchProfile()
           
 
Method Summary
 void add(FetchProfile.Item item)
          Add a predefined profile of headers.
 void add(java.lang.String header)
          Add a specific header.
 boolean contains(FetchProfile.Item item)
          Determine if the given profile item is already included.
 boolean contains(java.lang.String header)
          Determine if the specified header is already included.
 java.lang.String[] getHeaderNames()
          Get the headers that have already been included.
 FetchProfile.Item[] getItems()
          Get the profile items already included.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

items

private final java.util.List items

headers

private final java.util.List headers
Constructor Detail

FetchProfile

public FetchProfile()
Method Detail

add

public void add(FetchProfile.Item item)
Add a predefined profile of headers.


add

public void add(java.lang.String header)
Add a specific header.


contains

public boolean contains(FetchProfile.Item item)
Determine if the given profile item is already included.


contains

public boolean contains(java.lang.String header)
Determine if the specified header is already included.


getItems

public FetchProfile.Item[] getItems()
Get the profile items already included.


getHeaderNames

public java.lang.String[] getHeaderNames()
Get the headers that have already been included.