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.collections.bag;
18  
19  import java.util.Set;
20  
21  import org.apache.commons.collections.Bag;
22  import org.apache.commons.collections.collection.AbstractCollectionDecorator;
23  
24  /**
25   * Decorates another <code>Bag</code> to provide additional behaviour.
26   * <p>
27   * Methods are forwarded directly to the decorated bag.
28   *
29   * @since 3.0
30   * @version $Id: AbstractBagDecorator.java 1429905 2013-01-07 17:15:14Z ggregory $
31   */
32  public abstract class AbstractBagDecorator<E>
33          extends AbstractCollectionDecorator<E> implements Bag<E> {
34  
35      /** Serialization version */
36      private static final long serialVersionUID = -3768146017343785417L;
37  
38      /**
39       * Constructor only used in deserialization, do not use otherwise.
40       * @since 3.1
41       */
42      protected AbstractBagDecorator() {
43          super();
44      }
45  
46      /**
47       * Constructor that wraps (not copies).
48       * 
49       * @param bag  the bag to decorate, must not be null
50       * @throws IllegalArgumentException if list is null
51       */
52      protected AbstractBagDecorator(final Bag<E> bag) {
53          super(bag);
54      }
55  
56      /**
57       * Gets the bag being decorated.
58       * 
59       * @return the decorated bag
60       */
61      @Override
62      protected Bag<E> decorated() {
63          return (Bag<E>) super.decorated();
64      }
65  
66      //-----------------------------------------------------------------------
67      
68      public int getCount(final Object object) {
69          return decorated().getCount(object);
70      }
71  
72      public boolean add(final E object, final int count) {
73          return decorated().add(object, count);
74      }
75  
76      public boolean remove(final Object object, final int count) {
77          return decorated().remove(object, count);
78      }
79  
80      public Set<E> uniqueSet() {
81          return decorated().uniqueSet();
82      }
83  
84  }