com.gs.collections.api.bag.package-info Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Goldman Sachs.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * This package contains interfaces for Bag API.
 * 
 *     A Bag is a {@link java.util.Collection} which contains elements that are unordered, and may contain duplicate entries. It adds a protocol for
 * adding, removing, and determining the number of occurrences for an item.
 * 

 *     This package contains 3 interfaces:
 * 

 *     
 *          {@link com.gs.collections.api.bag.Bag} - contains the common API for Mutable and Immutable Bag.
 *     
 *     
 *          {@link com.gs.collections.api.bag.MutableBag} - a Bag whose contents can be altered after initialization.
 *     
 *     
 *          {@link com.gs.collections.api.bag.ImmutableBag} - a Bag whose contents cannot be altered after initialization.
 *     
 * 
 */
package com.gs.collections.api.bag;