59 lines
2.3 KiB
Java
59 lines
2.3 KiB
Java
/**
|
|
*
|
|
* 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;
|
|
|
|
/**
|
|
* 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.
|
|
* <p>
|
|
* 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).
|
|
*
|
|
* <pre>
|
|
* // 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);
|
|
* </pre>
|
|
*
|
|
* @see org.jivesoftware.smack.StanzaCollector
|
|
* @see org.jivesoftware.smack.StanzaListener
|
|
* @author Matt Tucker
|
|
*/
|
|
public interface StanzaFilter {
|
|
|
|
/**
|
|
* Tests whether or not the specified stanza should pass the filter.
|
|
*
|
|
* @param stanza the stanza(/packet) to test.
|
|
* @return true if and only if <tt>stanza</tt> passes the filter.
|
|
*/
|
|
boolean accept(Stanza stanza);
|
|
}
|