View Javadoc

1   /*
2     File: BoundedChannel.java
3   
4     Originally written by Doug Lea and released into the public domain.
5     This may be used for any purposes whatsoever without acknowledgment.
6     Thanks for the assistance and support of Sun Microsystems Labs,
7     and everyone contributing, testing, and using this code.
8   
9     History:
10    Date       Who                What
11    11Jun1998  dl               Create public version
12  */
13  
14  
15  package org.jdiagnose.concurrent;
16  
17  /***
18   * A channel that is known to have a capacity, signifying
19   * that <code>put</code> operations may block when the
20   * capacity is reached. Various implementations may have
21   * intrinsically hard-wired capacities, capacities that are fixed upon
22   * construction, or dynamically adjustable capacities.
23   * @see DefaultChannelCapacity
24   * <p>[<a href="http://gee.cs.oswego.edu/dl/classes/EDU/oswego/cs/dl/util/concurrent/intro.html"> Introduction to this package. </a>] <p>
25   **/
26  
27  public interface BoundedChannel extends Channel {
28    /*** 
29     * Return the maximum number of elements that can be held.
30     * @return the capacity of this channel.
31     **/
32    public int capacity();
33  }