001/**
002 *
003 * Copyright 2003-2007 Jive Software.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.jivesoftware.smack.filter;
019
020import org.jivesoftware.smack.packet.Message;
021import org.jivesoftware.smack.util.StringUtils;
022
023/**
024 * Filters for message packets with a particular thread value.
025 *
026 * @author Matt Tucker
027 */
028public class ThreadFilter extends FlexibleStanzaTypeFilter<Message> implements StanzaFilter {
029
030    private final String thread;
031
032    /**
033     * Creates a new thread filter using the specified thread value.
034     *
035     * @param thread the thread value to filter for.
036     */
037    public ThreadFilter(String thread) {
038        StringUtils.requireNotNullNorEmpty(thread, "Thread must not be null nor empty.");
039        this.thread = thread;
040    }
041
042    @Override
043    protected boolean acceptSpecific(Message message) {
044        return thread.equals(message.getThread());
045    }
046
047    @Override
048    public String toString() {
049        return getClass().getSimpleName() + ": thread=" + thread;
050    }
051}