geronimo-javamail_1.5/geronimo-javamail_1.4_provider/src/main/java/org/apache/geronimo/javamail/store/imap/connection/IMAPUntaggedResponse.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.geronimo.javamail.store.imap.connection;
import java.util.ArrayList;
import java.util.List;

import javax.mail.MessagingException;

/**
 * Util class to represent an untagged response from a IMAP server
 *
 * @version $Rev$ $Date$
 */
public class IMAPUntaggedResponse extends IMAPResponse {
    // the response key word 
    protected String keyword; 

    /**
     * Create a reply object from a server response line (normally, untagged).  This includes
     * doing the parsing of the response line.
     *
     * @param response The response line used to create the reply object.
     */
    public IMAPUntaggedResponse(String keyword, byte [] response) {
        super(response); 
        this.keyword = keyword; 
    }

    /**
     * Return the KEYWORD that identifies the type 
     * of this untagged response.
     * 
     * @return The identifying keyword.
     */
    public String getKeyword() {
        return keyword; 
    }
    
    
    /**
     * Test if an untagged response is of a given 
     * keyword type.
     * 
     * @param keyword The test keyword.
     * 
     * @return True if this is a type match, false for mismatches.
     */
    public boolean isKeyword(String keyword) {
        return this.keyword.equals(keyword); 
    }
}