View Javadoc

1   /**
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.geronimo.javamail.store.imap.connection;
19  import java.util.ArrayList;
20  import java.util.List;
21  
22  import javax.mail.MessagingException;
23  
24  /**
25   * Util class to represent an untagged response from a IMAP server
26   *
27   * @version $Rev: 594520 $ $Date: 2007-11-13 07:57:39 -0500 (Tue, 13 Nov 2007) $
28   */
29  public class IMAPUntaggedResponse extends IMAPResponse {
30      // the response key word 
31      protected String keyword; 
32  
33      /**
34       * Create a reply object from a server response line (normally, untagged).  This includes
35       * doing the parsing of the response line.
36       *
37       * @param response The response line used to create the reply object.
38       */
39      public IMAPUntaggedResponse(String keyword, byte [] response) {
40          super(response); 
41          this.keyword = keyword; 
42      }
43  
44      /**
45       * Return the KEYWORD that identifies the type 
46       * of this untagged response.
47       * 
48       * @return The identifying keyword.
49       */
50      public String getKeyword() {
51          return keyword; 
52      }
53      
54      
55      /**
56       * Test if an untagged response is of a given 
57       * keyword type.
58       * 
59       * @param keyword The test keyword.
60       * 
61       * @return True if this is a type match, false for mismatches.
62       */
63      public boolean isKeyword(String keyword) {
64          return this.keyword.equals(keyword); 
65      }
66  }
67