DequeueInterceptor


1   /* 
2    * Copyright 1999-2004 The Apache Software Foundation
3    * Licensed  under the  Apache License,  Version 2.0  (the "License");
4    * you may not use  this file  except in  compliance with the License.
5    * You may obtain a copy of the License at 
6    * 
7    *   http://www.apache.org/licenses/LICENSE-2.0
8    * 
9    * Unless required by applicable law or agreed to in writing, software
10   * distributed  under the  License is distributed on an "AS IS" BASIS,
11   * WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
12   * implied.
13   * 
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.excalibur.event;
18  
19  /**
20   * The dequeue executable interface describes operations that
21   * are executed before and after elements are pulled from a
22   * queue.
23   *
24   * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
25   * @version $Revision: 1.4 $
26   */
27  public interface DequeueInterceptor
28  {
29  
30      /**
31       * An operation executed before dequeing events from
32       * the queue. The Source is passed in so the implementation
33       * can determine to execute based on the queue properties.
34       *
35       * <p>
36       *   This method is called once at the beginning of any <code>dequeue</code>
37       *   method regardless of how many queue elements are dequeued.
38       * </p>
39       *
40       * @since Feb 10, 2003
41       *
42       * @param context  The source from which the dequeue is performed.
43       */
44      public void before(Source context);
45  
46      /**
47       * An operation executed after dequeing events from
48       * the queue. The Source is passed in so the implementation
49       * can determine to execute based on the queue properties.
50       *
51       * <p>
52       *   This method is called once at the end of any <code>dequeue</code>
53       *   method regardless of how many queue elements are dequeued.
54       * </p>
55       *
56       * @since Feb 10, 2003
57       *
58       * @param context  The source from which the dequeue is performed.
59       */
60      public void after(Source context);
61  }
62
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags