Subscriber


1   /*
2    * Copyright 1999-2002,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.apache.cocoon.portal.event;
17  
18  /**
19   * <tt>Subscriber</tt> registers its interest in a class of events and
20   * filters the events of which it should be notified.
21   *
22   * @author <a HREF="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
23   * @author <a HREF="mailto:volker.schmitt@basf-it-services.com">Volker Schmitt</a>
24   * @author Mauro Talevi
25   * @deprecated Use the {@link org.apache.cocoon.portal.event.Receiver} instead.
26   *
27   * @version CVS $Id: Subscriber.java 219049 2005-07-14 15:11:52Z cziegeler $
28   */
29  public interface Subscriber {
30  
31      /**
32       *  Returns the event type of the event on which the Subscriber is interested.
33       *  The event type is encoded by a <tt>Class</tt>.
34       *
35       *  @return the <tt>Class</tt> encoding the event type
36       */
37      Class   getEventType();
38  
39      /**
40       *  Returns the filter used to select the events in which the subscriber is
41       *  interested.
42       *
43       *  @return the <tt>Filter</tt>
44       */
45      Filter getFilter();
46  
47      /**
48       * Callback method informing the Subscriber of the occurence of an event.
49       *
50       * @param event the <tt>Event</tt> of which the <tt>Subscriber</tt> is informed
51       */
52      void inform( Event event );
53  }
54
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags