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 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
|
/*
* Copyright (C) 2002-2024 Sebastiano Vigna
*
* 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.
*/
package PACKAGE;
import java.util.AbstractCollection;
#if KEYS_PRIMITIVE
import java.util.Collection;
#endif
/** An abstract class providing basic methods for collections implementing a type-specific interface.
*
* <p>In particular, this class provide {@link #iterator()}, {@code add()}, {@link #remove(Object)} and
* {@link #contains(Object)} methods that just call the type-specific counterpart.
*
* <p><strong>Warning</strong>: Because of a name clash between the list and collection interfaces
* the type-specific deletion method of a type-specific abstract
* collection is {@code rem()}, rather then {@code remove()}. A
* subclass must thus override {@code rem()}, rather than
* {@code remove()}, to make all inherited methods work properly.
*/
public abstract class ABSTRACT_COLLECTION KEY_GENERIC extends AbstractCollection<KEY_GENERIC_CLASS> implements COLLECTION KEY_GENERIC {
protected ABSTRACT_COLLECTION() {}
@Override
public abstract KEY_ITERATOR KEY_GENERIC iterator();
#if KEYS_PRIMITIVE
/** {@inheritDoc}
*
* @implSpec This implementation always throws an {@link UnsupportedOperationException}.
*/
@Override
public boolean add(final KEY_TYPE k) {
throw new UnsupportedOperationException();
}
/** {@inheritDoc}
*
* @implSpec This implementation iterates over the elements in the collection,
* looking for the specified element.
*/
@Override
public boolean contains(final KEY_TYPE k) {
final KEY_ITERATOR iterator = iterator();
while (iterator.hasNext()) if (k == iterator.NEXT_KEY()) return true;
return false;
}
/** {@inheritDoc}
*
* @implSpec This implementation iterates over the elements in the collection,
* looking for the specified element and tries to remove it.
*/
@Override
public boolean rem(final KEY_TYPE k) {
final KEY_ITERATOR KEY_GENERIC iterator = iterator();
while (iterator.hasNext())
if (k == iterator.NEXT_KEY()) {
iterator.remove();
return true;
}
return false;
}
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public boolean add(final KEY_GENERIC_CLASS key) {
return COLLECTION.super.add(key);
}
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public boolean contains(final Object key) {
return COLLECTION.super.contains(key);
}
/** {@inheritDoc}
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public boolean remove(final Object key) {
return COLLECTION.super.remove(key);
}
@Override
public KEY_TYPE[] toArray(KEY_TYPE[] a) {
final int size = size();
if (a == null) {
a = new KEY_TYPE[size];
} else if (a.length < size) {
a = java.util.Arrays.copyOf(a, size);
}
ITERATORS.unwrap(iterator(), a);
return a;
}
@Override
public KEY_TYPE[] TO_KEY_ARRAY() {
final int size = size();
if (size == 0) return ARRAYS.EMPTY_ARRAY;
final KEY_TYPE a[] = new KEY_TYPE[size];
ITERATORS.unwrap(iterator(), a);
return a;
}
/** {@inheritDoc}
* @deprecated Please use {@code toArray()} instead—this method is redundant and will be removed in the future.
*/
@Deprecated
@Override
public KEY_TYPE[] TO_KEY_ARRAY(final KEY_TYPE[] a) {
return toArray(a);
}
#if KEYS_INT_LONG_DOUBLE
/** {@inheritDoc}
*
* @apiNote This method exists to make final what should have been final in the interface.
*/
@Override
public final void forEach(final KEY_CONSUMER action) {
COLLECTION.super.forEach(action);
}
/** {@inheritDoc}
*
* @apiNote This method exists to make final what should have been final in the interface.
*/
@Override
public final boolean removeIf(final KEY_PREDICATE filter) {
return COLLECTION.super.removeIf(filter);
}
#endif
@Override
public boolean addAll(final COLLECTION c) {
boolean retVal = false;
for(final KEY_ITERATOR i = c.iterator(); i.hasNext();)
if (add(i.NEXT_KEY())) retVal = true;
return retVal;
}
/** {@inheritDoc}
*
* @implSpec This implementation delegates to the type-specific version if given a type-specific
* collection, otherwise is uses the implementation from {@link AbstractCollection}.
*/
@Override
public boolean addAll(final Collection<? extends KEY_CLASS> c) {
if (c instanceof COLLECTION) {
return addAll((COLLECTION) c);
}
return super.addAll(c);
}
@Override
public boolean containsAll(final COLLECTION c) {
for(final KEY_ITERATOR i = c.iterator(); i.hasNext();)
if (! contains(i.NEXT_KEY())) return false;
return true;
}
/** {@inheritDoc}
*
* @implSpec This implementation delegates to the type-specific version if given a type-specific
* collection, otherwise is uses the implementation from {@link AbstractCollection}.
*/
@Override
public boolean containsAll(final Collection<?> c) {
if (c instanceof COLLECTION) {
return containsAll((COLLECTION) c);
}
return super.containsAll(c);
}
@Override
public boolean removeAll(final COLLECTION c) {
boolean retVal = false;
for(final KEY_ITERATOR i = c.iterator(); i.hasNext();)
if (rem(i.NEXT_KEY())) retVal = true;
return retVal;
}
/** {@inheritDoc}
*
* @implSpec This implementation delegates to the type-specific version if given a type-specific
* collection, otherwise is uses the implementation from {@link AbstractCollection}.
*/
@Override
public boolean removeAll(final Collection<?> c) {
if (c instanceof COLLECTION) {
return removeAll((COLLECTION) c);
}
return super.removeAll(c);
}
@Override
public boolean retainAll(final COLLECTION c) {
boolean retVal = false;
for(final KEY_ITERATOR i = iterator(); i.hasNext();)
if (! c.contains(i.NEXT_KEY())) {
i.remove();
retVal = true;
}
return retVal;
}
/** {@inheritDoc}
*
* @implSpec This implementation delegates to the type-specific version if given a type-specific
* collection, otherwise is uses the implementation from {@link AbstractCollection}.
*/
@Override
public boolean retainAll(final Collection<?> c) {
if (c instanceof COLLECTION) {
return retainAll((COLLECTION) c);
}
return super.retainAll(c);
}
#endif
@Override
public String toString() {
final StringBuilder s = new StringBuilder();
final KEY_ITERATOR KEY_GENERIC i = iterator();
int n = size();
KEY_TYPE k;
boolean first = true;
s.append("{");
while(n-- != 0) {
if (first) first = false;
else s.append(", ");
k = i.NEXT_KEY();
#if KEYS_REFERENCE
if (this == k) s.append("(this collection)"); else
#endif
s.append(String.valueOf(k));
}
s.append("}");
return s.toString();
}
}
|