/** * * Copyright 2003-2007 Jive Software. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.jivesoftware.smack.filter; import org.jivesoftware.smack.packet.Stanza; import org.jivesoftware.smack.util.Predicate; /** * Defines a way to filter stanzas for particular attributes. Stanza filters are used when * constructing stanza listeners or collectors -- the filter defines what stanzas match the criteria * of the collector or listener for further stanza processing. *
* Several simple filters are pre-defined. These filters can be logically combined for more complex * stanza filtering by using the {@link org.jivesoftware.smack.filter.AndFilter AndFilter} and * {@link org.jivesoftware.smack.filter.OrFilter OrFilter} filters. It's also possible to define * your own filters by implementing this interface. The code example below creates a trivial filter * for stanzas with a specific ID (real code should use {@link StanzaIdFilter} instead). * *
* // Use an anonymous inner class to define a stanza filter that returns * // all stanzas that have a stanza ID of "RS145". * StanzaFilter myFilter = new StanzaFilter() { * public boolean accept(Stanza stanza) { * return "RS145".equals(stanza.getStanzaId()); * } * }; * // Create a new stanza collector using the filter we created. * StanzaCollector myCollector = connection.createStanzaCollector(myFilter); **
* As a rule of thumb: If you have a predicate method, that is, a method which takes a single Stanza as argument, is pure * (side effect free) and returns only a boolean, then it is a good indicator that the logic should be put into a * {@link StanzaFilter} (and be referenced in {@link org.jivesoftware.smack.StanzaListener}). *
* * @see org.jivesoftware.smack.StanzaCollector * @see org.jivesoftware.smack.StanzaListener * @author Matt Tucker */ public interface StanzaFilter extends Predicatestanza
passes the filter.
*/
boolean accept(Stanza stanza);
@Override
default boolean test(Stanza stanza) {
return accept(stanza);
}
default