001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.collections4;
018
019import java.util.Collection;
020
021/**
022 * Defines a collection that is bounded in size.
023 * <p>
024 * The size of the collection can vary, but it can never exceed a preset
025 * maximum number of elements. This interface allows the querying of details
026 * associated with the maximum number of elements.
027 * </p>
028 *
029 * @see CollectionUtils#isFull
030 * @see CollectionUtils#maxSize
031 *
032 * @param <E> the type of elements in this collection
033 * @since 3.0
034 */
035public interface BoundedCollection<E> extends Collection<E> {
036
037    /**
038     * Returns true if this collection is full and no new elements can be added.
039     *
040     * @return <code>true</code> if the collection is full.
041     */
042    boolean isFull();
043
044    /**
045     * Gets the maximum size of the collection (the bound).
046     *
047     * @return the maximum number of elements the collection can hold.
048     */
049    int maxSize();
050
051}