org.jivesoftware.smack.filter

Class FromMatchesFilter

java.lang.Object

org.jivesoftware.smack.filter.FromMatchesFilter

All Implemented Interfaces:

StanzaFilter

public class FromMatchesFilter
extends Object
implements StanzaFilter

Filter for packets where the "from" field exactly matches a specified JID. If the specified address is a bare JID then the filter will match any address whose bare JID matches the specified JID. But if the specified address is a full JID then the filter will only match if the sender of the stanza(/packet) matches the specified resource.

Constructor Summary

Constructors

Constructor and Description
FromMatchesFilter(String address, boolean matchBare) Creates a filter matching on the "from" field.

Method Summary

Modifier and Type	Method and Description
boolean	accept(Stanza packet) Tests whether or not the specified stanza should pass the filter.
static FromMatchesFilter	create(String address) Creates a filter matching on the "from" field.
static FromMatchesFilter	createBare(String address) Creates a filter matching on the "from" field.
static FromMatchesFilter	createFull(String address) Creates a filter matching on the "from" field.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FromMatchesFilter

public FromMatchesFilter(String address,
                         boolean matchBare)

Creates a filter matching on the "from" field. The from address must be the same as the filter address. The second parameter specifies whether the full or the bare addresses are compared.

Parameters:

address - The address to filter for. If null is given, the stanza(/packet) must not have a from address.

matchBare -

Method Detail

create

public static FromMatchesFilter create(String address)

Creates a filter matching on the "from" field. If the filter address is bare, compares the filter address with the bare from address. Otherwise, compares the filter address with the full from address.

Parameters:

address - The address to filter for. If null is given, the stanza(/packet) must not have a from address.

createBare

public static FromMatchesFilter createBare(String address)

Creates a filter matching on the "from" field. Compares the bare version of from and filter address.

Parameters:

address - The address to filter for. If null is given, the stanza(/packet) must not have a from address.

createFull

public static FromMatchesFilter createFull(String address)

Creates a filter matching on the "from" field. Compares the full version of from and filter address.

Parameters:

address - The address to filter for. If null is given, the stanza(/packet) must not have a from address.

accept

public boolean accept(Stanza packet)

Description copied from interface: StanzaFilter

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

Specified by:

accept in interface StanzaFilter

Parameters:

packet - the stanza(/packet) to test.

Returns:

true if and only if stanza passes the filter.

toString

public String toString()

Overrides:

toString in class Object