001    /*
002     * Copyright 2010 the original author or authors.
003     * 
004     *  Licensed under the Apache License, Version 2.0 (the "License");
005     *  you may not use this file except in compliance with the License.
006     *  You may obtain a copy of the License at
007     *
008     *      http://www.apache.org/licenses/LICENSE-2.0
009     *
010     *  Unless required by applicable law or agreed to in writing, software
011     *  distributed under the License is distributed on an "AS IS" BASIS,
012     *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     *  See the License for the specific language governing permissions and
014     *  limitations under the License.
015     */
016    package com.hs.mail.imap.message.search;
017    
018    /**
019     * This class implements search-criteria for Message Keyword (User Flag).
020     * 
021     * @author Won Chul Doh
022     * @since Jan 30, 2010
023     * 
024     */
025    public final class KeywordKey extends StringKey {
026    
027            /**
028             * Indicates whether to test for the presence or absence of the specified
029             * keyword. If <code>true</code>, then test whether the specified keyword is
030             * present, else test whether the specified keyword is absent.
031             */
032            protected boolean set;
033    
034            public KeywordKey(String keyword, boolean set) {
035                    super(keyword, false);
036                    this.set = set;
037            }
038    
039            public boolean getTestSet() {
040                    return set;
041            }
042    
043        public boolean equals(Object obj) {
044                    if (!(obj instanceof KeywordKey))
045                            return false;
046                    KeywordKey kk = (KeywordKey) obj;
047                    return kk.set == this.set && super.equals(obj);
048            }
049    
050            @Override
051            public boolean isComposite() {
052                    return true;
053            }
054    
055    }