Home | History | Annotate | Download | only in filter
      1 /**
      2  * $RCSfile$
      3  * $Revision$
      4  * $Date$
      5  *
      6  * Copyright 2003-2007 Jive Software.
      7  *
      8  * All rights reserved. Licensed under the Apache License, Version 2.0 (the "License");
      9  * you may not use this file except in compliance with the License.
     10  * You may obtain a copy of the License at
     11  *
     12  *     http://www.apache.org/licenses/LICENSE-2.0
     13  *
     14  * Unless required by applicable law or agreed to in writing, software
     15  * distributed under the License is distributed on an "AS IS" BASIS,
     16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     17  * See the License for the specific language governing permissions and
     18  * limitations under the License.
     19  */
     20 
     21 package org.jivesoftware.smack.filter;
     22 
     23 import org.jivesoftware.smack.packet.Packet;
     24 
     25 /**
     26  * Filters for packets of a particular type. The type is given as a Class object, so
     27  * example types would:
     28  * <ul>
     29  *      <li><tt>Message.class</tt>
     30  *      <li><tt>IQ.class</tt>
     31  *      <li><tt>Presence.class</tt>
     32  * </ul>
     33  *
     34  * @author Matt Tucker
     35  */
     36 public class PacketTypeFilter implements PacketFilter {
     37 
     38     Class<? extends Packet> packetType;
     39 
     40     /**
     41      * Creates a new packet type filter that will filter for packets that are the
     42      * same type as <tt>packetType</tt>.
     43      *
     44      * @param packetType the Class type.
     45      */
     46     public PacketTypeFilter(Class<? extends Packet> packetType) {
     47         // Ensure the packet type is a sub-class of Packet.
     48         if (!Packet.class.isAssignableFrom(packetType)) {
     49             throw new IllegalArgumentException("Packet type must be a sub-class of Packet.");
     50         }
     51         this.packetType = packetType;
     52     }
     53 
     54     public boolean accept(Packet packet) {
     55         return packetType.isInstance(packet);
     56     }
     57 
     58     public String toString() {
     59         return "PacketTypeFilter: " + packetType.getName();
     60     }
     61 }
     62