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.Stanza;
021import org.jivesoftware.smack.util.StringUtils;
022
023/**
024 * Filters for Stanzas with a particular stanza ID.
025 *
026 * @author Matt Tucker
027 */
028public class StanzaIdFilter implements StanzaFilter {
029
030    private final String stanzaId;
031
032    /**
033     * Creates a new stanza ID filter using the specified stanza's ID.
034     *
035     * @param stanza the stanza which the ID is taken from.
036     */
037    public StanzaIdFilter(Stanza stanza) {
038        this(stanza.getStanzaId());
039    }
040
041    /**
042     * Creates a new stanza ID filter using the specified stanza ID.
043     *
044     * @param stanzaId the stanza ID to filter for.
045     */
046    public StanzaIdFilter(String stanzaId) {
047        this.stanzaId = StringUtils.requireNotNullNorEmpty(stanzaId, "Stanza ID must not be null nor empty.");
048    }
049
050    @Override
051    public boolean accept(Stanza stanza) {
052        return stanzaId.equals(stanza.getStanzaId());
053    }
054
055    @Override
056    public String toString() {
057        return getClass().getSimpleName() + ": id=" + stanzaId;
058    }
059}