ViewVC Help
View File | Revision Log | Show Annotations | Revision Graph | Root Listing
root/i-scream/projects/cms/source/server/uk/org/iscream/cms/server/filter/PluginFilter.java
(Generate patch)

Comparing projects/cms/source/server/uk/org/iscream/cms/server/filter/PluginFilter.java (file contents):
Revision 1.1 by tdb, Wed Dec 6 22:58:30 2000 UTC vs.
Revision 1.4 by tdb, Thu Feb 1 00:18:42 2001 UTC

# Line 1 | Line 1
1 < //---PACKAGE DECLARATION---
2 < package uk.ac.ukc.iscream.filter;
3 <
4 < //---IMPORTS---
5 < import uk.ac.ukc.iscream.util.XMLPacket;
6 <
7 < /**
8 < * the plugin filter interface
9 < *
10 < * @author  $Author$
11 < * @version $Id$
12 < */
13 < public interface PluginFilter {
14 <  
15 < //---STATIC METHODS---
16 <
17 < //---CONSTRUCTORS---
18 <
19 < //---PUBLIC METHODS---
20 <
21 <    // return true if the filter wishes to allow the XMLPacket to pass
22 <    // to the next stage of the plugin filter pipeline.  return false
23 <    // otherwise.
24 <    public boolean runFilter(XMLPacket packet);
25 <    
26 <    
27 <    // return a String representation of what the plugin filter
28 <    // does (e.g. "Rejects packets if x y and z")
29 <    public String getDescription();
30 <
31 < //---PRIVATE METHODS---
32 <
33 < //---ACCESSOR/MUTATOR METHODS---
34 <
35 < }
1 > //---PACKAGE DECLARATION---
2 > package uk.ac.ukc.iscream.filter;
3 >
4 > //---IMPORTS---
5 > import uk.ac.ukc.iscream.util.XMLPacket;
6 >
7 > /**
8 > * An interface to which a Plugin for a Filter must adhere.
9 > *
10 > * @author  $Author$
11 > * @version $Id$
12 > */
13 > public interface PluginFilter {
14 >
15 > //---STATIC METHODS---
16 >
17 > //---CONSTRUCTORS---
18 >
19 > //---PUBLIC METHODS---
20 >
21 >    /**
22 >     * Return true if the filter wishes to allow the XMLPacket to pass
23 >     * to the next stage of the plugin filter pipeline.  return false
24 >     * otherwise.
25 >     *
26 >     * @param packet the packet to filter on
27 >     * @return whether the packet is allow to continue on
28 >     */
29 >    public boolean runFilter(XMLPacket packet);
30 >    
31 >    
32 >    /**
33 >     * Return a String representation of what the plugin filter
34 >     * does (e.g. "Rejects packets if x, y, and z")
35 >     *
36 >     * @return the description
37 >     */
38 >    public String getDescription();
39 >
40 > //---PRIVATE METHODS---
41 >
42 > //---ACCESSOR/MUTATOR METHODS---
43 >
44 > }

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines