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