KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > util > WaitSync


1 /*
2   * JBoss, Home of Professional Open Source
3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
4   * by the @authors tag. See the copyright.txt in the distribution for a
5   * full listing of individual contributors.
6   *
7   * This is free software; you can redistribute it and/or modify it
8   * under the terms of the GNU Lesser General Public License as
9   * published by the Free Software Foundation; either version 2.1 of
10   * the License, or (at your option) any later version.
11   *
12   * This software is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15   * Lesser General Public License for more details.
16   *
17   * You should have received a copy of the GNU Lesser General Public
18   * License along with this software; if not, write to the Free
19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21   */
22 package org.jboss.util;
23
24 /**
25  * Interface that gives wait - notify primitives to implementors.
26  *
27  * @see Semaphore
28  *
29  * @author <a HREF="mailto:simone.bordet@compaq.com">Simone Bordet</a>
30  * @version $Revision: 1958 $
31  */
32 public interface WaitSync
33    extends Sync
34 {
35    /**
36     * Pone in wait status this sync, until {@link #doNotify} is called to wake it up.
37     *
38     * @see #doNotify
39     */
40    void doWait() throws InterruptedException JavaDoc;
41    
42    /**
43     * Wakes up this sync that has been posed in wait status by a {@link #doWait} call.
44     * If this sync is not waiting, invoking this method should have no effect.
45     * @see #doWait
46     */
47    void doNotify() throws InterruptedException JavaDoc;
48 }
49
Popular Tags