KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > excalibur > event > PreparedEnqueue


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  * A <code>PreparedEnqueue</code> is an object returned from a
21  * <code>prepareEnqueue</code> method that allows you to either
22  * commit or abort the enqueue operation.
23  *
24  * @author <a HREF="mailto:dev@avalon.apache.org">Avalon Development Team</a>
25  */
26 public interface PreparedEnqueue
27 {
28     /**
29      * Commit a previously prepared provisional enqueue operation (from
30      * the <code>prepareEnqueue</code> method). Causes the provisionally
31      * enqueued elements to appear on the queue for future dequeue
32      * operations. Note that once a <code>prepareEnqueue</code> has returned
33      * an enqueue key, the queue cannot reject the entries.
34      */
35     void commit();
36
37     /**
38      * Abort a previously prepared provisional enqueue operation (from
39      * the <code>prepareEnqueue</code> method). Causes the queue to discard
40      * the provisionally enqueued elements.
41      */
42     void abort();
43 }
44
Popular Tags