org.jivesoftware.smack.filter

Interface StanzaFilter

All Known Subinterfaces:

PacketFilter

All Known Implementing Classes:

AbstractListFilter, AfterXStanzas, AndFilter, DelayedStanzaFilter, FlexibleStanzaTypeFilter, ForEveryMessage, ForEveryStanza, ForMatchingPredicateOrAfterXStanzas, FromMatchesFilter, IQReplyFilter, IQResultReplyFilter, IQTypeFilter, MessageTypeFilter, MessageWithBodiesFilter, MessageWithSubjectFilter, NotFilter, OnceForThisStanza, OrFilter, PacketExtensionFilter, PacketIDFilter, PacketTypeFilter, PresenceTypeFilter, SetActiveListFilter, SetDefaultListFilter, ShortcutPredicates, StanzaExtensionFilter, StanzaIdFilter, StanzaTypeFilter, ThreadFilter, ToFilter

public interface StanzaFilter

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 AndFilter and 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 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.
 PacketCollector myCollector = connection.createPacketCollector(myFilter);
 

See Also:

PacketCollector, StanzaListener

Method Summary

Modifier and Type	Method and Description
boolean	accept(Stanza stanza) Tests whether or not the specified stanza should pass the filter.

Method Detail

accept

boolean accept(Stanza stanza)

Tests whether or not the specified stanza should pass the filter.

Parameters:

stanza - the stanza(/packet) to test.

Returns:

true if and only if stanza passes the filter.