blob: 634e68ea2c6efd75e84d29b20ccaad8d3a1a8a84 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
/**
* $RCSfile$
* $Revision$
* $Date$
*
* Copyright 2003-2007 Jive Software.
*
* All rights reserved. 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.Packet;
/**
* Defines a way to filter packets for particular attributes. Packet filters are
* used when constructing packet listeners or collectors -- the filter defines
* what packets match the criteria of the collector or listener for further
* packet processing.<p>
*
* Several pre-defined filters are defined. These filters can be logically combined
* for more complex packet 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 packets with a specific ID.
*
* <pre>
* // Use an anonymous inner class to define a packet filter that returns
* // all packets that have a packet ID of "RS145".
* PacketFilter myFilter = new PacketFilter() {
* public boolean accept(Packet packet) {
* return "RS145".equals(packet.getPacketID());
* }
* };
* // Create a new packet collector using the filter we created.
* PacketCollector myCollector = packetReader.createPacketCollector(myFilter);
* </pre>
*
* @see org.jivesoftware.smack.PacketCollector
* @see org.jivesoftware.smack.PacketListener
* @author Matt Tucker
*/
public interface PacketFilter {
/**
* Tests whether or not the specified packet should pass the filter.
*
* @param packet the packet to test.
* @return true if and only if <tt>packet</tt> passes the filter.
*/
public boolean accept(Packet packet);
}
|
