View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.collections4;
18  
19  import java.util.Collection;
20  
21  /**
22   * Defines a collection that is bounded in size.
23   * <p>
24   * The size of the collection can vary, but it can never exceed a preset
25   * maximum number of elements. This interface allows the querying of details
26   * associated with the maximum number of elements.
27   * </p>
28   *
29   * @see CollectionUtils#isFull
30   * @see CollectionUtils#maxSize
31   *
32   * @param <E> the type of elements in this collection
33   * @since 3.0
34   */
35  public interface BoundedCollection<E> extends Collection<E> {
36  
37      /**
38       * Returns true if this collection is full and no new elements can be added.
39       *
40       * @return <code>true</code> if the collection is full.
41       */
42      boolean isFull();
43  
44      /**
45       * Gets the maximum size of the collection (the bound).
46       *
47       * @return the maximum number of elements the collection can hold.
48       */
49      int maxSize();
50  
51  }