1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/*******************************************************************************
* Copyright (c) 2005, 2008 Oracle. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0, which accompanies this distribution
* and is available at http://www.eclipse.org/legal/epl-v10.html.
*
* Contributors:
* Oracle - initial API and implementation
******************************************************************************/
package org.eclipse.jpt.utility.internal;
import java.io.Serializable;
import java.util.AbstractCollection;
import java.util.Iterator;
import org.eclipse.jpt.utility.internal.iterators.EmptyIterator;
/**
* A collection that allows duplicate elements.
* <p>
* The <code>Bag</code> interface places additional stipulations,
* beyond those inherited from the <code>java.util.Collection</code> interface,
* on the contracts of the <code>equals</code> and <code>hashCode</code> methods.
*
* @see HashBag
*/
public interface Bag<E> extends java.util.Collection<E> {
/**
* Compares the specified object with this bag for equality. Returns
* <code>true</code> if the specified object is also a bag, the two bags
* have the same size, and every member of the specified bag is
* contained in this bag with the same number of occurrences (or equivalently,
* every member of this bag is contained in the specified bag with the same
* number of occurrences). This definition ensures that the
* equals method works properly across different implementations of the
* bag interface.
*/
boolean equals(Object o);
/**
* Returns the hash code value for this bag. The hash code of a bag is
* defined to be the sum of the hash codes of the elements in the bag,
* where the hashcode of a <code>null</code> element is defined to be zero.
* This ensures that <code>b1.equals(b2)</code> implies that
* <code>b1.hashCode() == b2.hashCode()</code> for any two bags
* <code>b1</code> and <code>b2</code>, as required by the general
* contract of the <code>Object.hashCode</code> method.
*/
int hashCode();
/**
* Return the number of times the specified object occurs in the bag.
*/
int count(Object o);
/**
* Add the specified object the specified number of times to the bag.
*/
boolean add(E o, int count);
/**
* Remove the specified number of occurrences of the specified object
* from the bag. Return whether the bag changed.
*/
boolean remove(Object o, int count);
/**
* Return an iterator that returns each item in the bag
* once and only once, irrespective of how many times
* the item was added to the bag.
*/
java.util.Iterator<E> uniqueIterator();
final class Empty<E> extends AbstractCollection<E> implements Bag<E>, Serializable {
@SuppressWarnings("unchecked")
public static final Bag INSTANCE = new Empty();
@SuppressWarnings("unchecked")
public static <T> Bag<T> instance() {
return INSTANCE;
}
// ensure single instance
private Empty() {
super();
}
@Override
public Iterator<E> iterator() {
return EmptyIterator.instance();
}
@Override
public int size() {
return 0;
}
public Iterator<E> uniqueIterator() {
return EmptyIterator.instance();
}
public int count(Object o) {
return 0;
}
public boolean remove(Object o, int count) {
return false;
}
public boolean add(E o, int count) {
throw new UnsupportedOperationException();
}
@Override
public boolean equals(Object o) {
if (o == this) {
return true;
}
if ( ! (o instanceof Bag)) {
return false;
}
return ((Bag<?>) o).size() == 0;
}
@Override
public int hashCode() {
return 0;
}
private static final long serialVersionUID = 1L;
private Object readResolve() {
return INSTANCE;
}
}
}
|
