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