KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > ristretto > pop3 > POP3Response


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.pop3;
37
38 import org.columba.ristretto.io.Source;
39
40 /**
41  * Representation of a response from a POP3 server.
42  *
43  * @author tstich
44  *
45  */
46 public class POP3Response {
47
48     /**
49      * Response type.
50      */
51     public static final int OK = 0;
52     /**
53      * Response type.
54      */
55     public static final int ERR = -1;
56     
57     private int type;
58     private String JavaDoc message;
59     private Source data;
60     private CharSequence JavaDoc source;
61     
62     /**
63      * Constructs the POP3Response.
64      *
65      * @param source
66      */
67     public POP3Response(CharSequence JavaDoc source) {
68         this.source = source;
69     };
70     
71     
72
73     /**
74      * @return the data
75      */
76     public Source getData() {
77         return data;
78     }
79
80     /**
81      * Set the data.
82      *
83      * @param data
84      */
85     public void setData(Source data) {
86         this.data = data;
87     }
88
89     /**
90      * @return the message
91      */
92     public String JavaDoc getMessage() {
93         return message;
94     }
95
96     /**
97      * Set the message.
98      *
99      * @param message
100      */
101     public void setMessage(String JavaDoc message) {
102         this.message = message;
103     }
104
105     /**
106      * @return the type
107      */
108     public int getType() {
109         return type;
110     }
111
112     /**
113      * Set the type.
114      *
115      * @param type
116      */
117     public void setType(int type) {
118         this.type = type;
119     }
120     
121     /**
122      * @return <code>true</true> if the type is OK
123      */
124     public boolean isOK() {
125         return type == OK;
126     }
127     
128     /**
129      * @return <code>true</true> if the type is ERR
130      */
131     public boolean isERR() {
132         return type == ERR;
133     }
134
135     /**
136      * @return the source
137      */
138     public CharSequence JavaDoc getSource() {
139         return source;
140     }
141
142     /**
143      * Set the source.
144      *
145      * @param source
146      */
147     public void setSource(CharSequence JavaDoc source) {
148         this.source = source;
149     }
150
151 }
152
Popular Tags