KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > ristretto > imap > ListInfo


1 /* ***** BEGIN LICENSE BLOCK *****
2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3  *
4  * The contents of this file are subject to the Mozilla Public License Version
5  * 1.1 (the "License"); you may not use this file except in compliance with
6  * the License. You may obtain a copy of the License at
7  * http://www.mozilla.org/MPL/
8  *
9  * Software distributed under the License is distributed on an "AS IS" basis,
10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11  * for the specific language governing rights and limitations under the
12  * License.
13  *
14  * The Original Code is Ristretto Mail API.
15  *
16  * The Initial Developers of the Original Code are
17  * Timo Stich and Frederik Dietz.
18  * Portions created by the Initial Developers are Copyright (C) 2004
19  * All Rights Reserved.
20  *
21  * Contributor(s):
22  *
23  * Alternatively, the contents of this file may be used under the terms of
24  * either the GNU General Public License Version 2 or later (the "GPL"), or
25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
26  * in which case the provisions of the GPL or the LGPL are applicable instead
27  * of those above. If you wish to allow use of your version of this file only
28  * under the terms of either the GPL or the LGPL, and not to allow others to
29  * use your version of this file under the terms of the MPL, indicate your
30  * decision by deleting the provisions above and replace them with the notice
31  * and other provisions required by the GPL or the LGPL. If you do not delete
32  * the provisions above, a recipient may use your version of this file under
33  * the terms of any one of the MPL, the GPL or the LGPL.
34  *
35  * ***** END LICENSE BLOCK ***** */
36 package org.columba.ristretto.imap;
37
38 /**
39  * This class represents a listinfo like returned from a LSUB or LIST response.
40  * <p>
41  * For further information especially on the parameters see RFC 3501.
42  *
43  * @author Timo Stich <tstich@users.sourceforge.net>
44  */
45 public class ListInfo implements Comparable JavaDoc {
46     
47     /**
48      * ListInfo parameter. There are no inferiors for this mailbox.
49      */
50     public static final int NOINFERIORS = 1;
51
52     /**
53      * ListInfo parameter. The SELECT command on this mailbox is forbidden.
54      */
55     public static final int NOSELECT = 2;
56
57     /**
58      * ListInfo parameter. This mailbox is marked.
59      */
60     public static final int MARKED = 4;
61
62     /**
63      * ListInfo parameter. This mailbox is unmarked.
64      */
65     public static final int UNMARKED = 8;
66
67     protected String JavaDoc mailboxName;
68     protected String JavaDoc delimiter;
69     protected int parameters;
70
71     /**
72      * Contstructs a ListInfo.
73      *
74      * @param name of the mailbox
75      * @param delimiter the delimiter of the imap server
76      * @param parameters
77      */
78     public ListInfo(String JavaDoc name, String JavaDoc delimiter, int parameters) {
79         this.mailboxName = name;
80         this.delimiter = delimiter;
81         this.parameters = parameters;
82     }
83     
84     /**
85      * Gets the name of the mailbox.
86      *
87      * @return name of the mailbox.
88      */
89     public String JavaDoc getName() {
90         return mailboxName;
91     }
92     
93     /**
94      * Checks if the parameter NOSELECT is not set.
95      *
96      * @return boolean true if NOSELECT is not set, else false.
97      */
98     public boolean isSelectable() {
99         return !getParameter(NOSELECT);
100     }
101
102     /**
103      * Gets the delimiter of the imap server.
104      * For example '.' or '/'.
105      *
106      * @return the delimiter
107      */
108     public String JavaDoc getDelimiter() {
109         return delimiter;
110     }
111     
112     /**
113      * Check if this parameter is set.
114      *
115      * @param parameter
116      * @return true if the parameter is set, else false.
117      */
118     public boolean getParameter(int parameter) {
119         return (parameters & parameter) > 0;
120     }
121
122     /**
123      * @see java.lang.Comparable#compareTo(java.lang.Object)
124      */
125     public int compareTo(Object JavaDoc arg0) {
126         return mailboxName.compareTo(((ListInfo)arg0).getName());
127     }
128
129 }
130
Popular Tags