StanzaIdFilter.java

  1. /**
  2.  *
  3.  * Copyright 2003-2007 Jive Software.
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */

  17. package org.jivesoftware.smack.filter;

  18. import org.jivesoftware.smack.packet.Stanza;
  19. import org.jivesoftware.smack.packet.StanzaView;
  20. import org.jivesoftware.smack.util.StringUtils;

  21. /**
  22.  * Filters for Stanzas with a particular stanza ID.
  23.  *
  24.  * @author Matt Tucker
  25.  */
  26. public class StanzaIdFilter implements StanzaFilter {

  27.     private final String stanzaId;

  28.     /**
  29.      * Creates a new stanza ID filter using the specified stanza's ID.
  30.      *
  31.      * @param stanza the stanza which the ID is taken from.
  32.      */
  33.     public StanzaIdFilter(StanzaView stanza) {
  34.         this(stanza.getStanzaId());
  35.     }

  36.     /**
  37.      * Creates a new stanza ID filter using the specified stanza ID.
  38.      *
  39.      * @param stanzaId the stanza ID to filter for.
  40.      */
  41.     public StanzaIdFilter(String stanzaId) {
  42.         this.stanzaId = StringUtils.requireNotNullNorEmpty(stanzaId, "Stanza ID must not be null nor empty.");
  43.     }

  44.     @Override
  45.     public boolean accept(Stanza stanza) {
  46.         return stanzaId.equals(stanza.getStanzaId());
  47.     }

  48.     @Override
  49.     public String toString() {
  50.         return getClass().getSimpleName() + ": id=" + stanzaId;
  51.     }
  52. }