it.unimi.dsi.fastutil.shorts.AbstractShortCollection Maven / Gradle / Ivy
/*
* Copyright (C) 2002-2017 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 it.unimi.dsi.fastutil.shorts;
import java.util.AbstractCollection;
/** An abstract class providing basic methods for collections implementing a type-specific interface.
*
* In particular, this class provide {@link #iterator()}, add()
, {@link #remove(Object)} and
* {@link #contains(Object)} methods that just call the type-specific counterpart.
*
*
Warning: Because of a name clash between the list and collection interfaces
* the type-specific deletion method of a type-specific abstract
* collection is rem()
, rather then remove()
. A
* subclass must thus override rem()
, rather than
* remove()
, to make all inherited methods work properly.
*/
public abstract class AbstractShortCollection extends AbstractCollection implements ShortCollection {
protected AbstractShortCollection() {}
/** {@inheritDoc}
*
* This implementation delegates to the new covariantly stronger generic method {@link #iterator()}.
* @deprecated As of fastutil
5, replaced by {@link #iterator()}.
*/
@Deprecated
@Override
public ShortIterator shortIterator() {
return iterator();
}
@Override
public abstract ShortIterator iterator();
/** {@inheritDoc}
*
*
This implementation always throws an {@link UnsupportedOperationException}.
*/
@Override
public boolean add(final short k) {
throw new UnsupportedOperationException();
}
/** {@inheritDoc}
*
*
This implementation iterates over the elements in the collection,
* looking for the specified element.
*/
public boolean contains(final short k) {
final ShortIterator iterator = iterator();
while (iterator.hasNext()) if (k == iterator.nextShort()) return true;
return false;
}
/** {@inheritDoc}
*
*
This implementation iterates over the elements in the collection,
* looking for the specified element and tries to remove it.
*/
@Override
public boolean rem(final short k) {
final ShortIterator iterator = iterator();
while (iterator.hasNext())
if (k == iterator.nextShort()) {
iterator.remove();
return true;
}
return false;
}
/** {@inheritDoc}
*
*
This implementation delegates to the corresponding type-specific method.
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public boolean add(final Short o) {
return add(o.shortValue());
}
/** {@inheritDoc}
*
*
This implementation delegates to the corresponding type-specific method.
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
public boolean contains(final Object o) {
if (o == null) return false;
return contains(((((Short)(o)).shortValue())));
}
/** {@inheritDoc}
*
This implementation delegates to the {@code rem()} method.
* @deprecated Please use (and implement) the {@code rem()} method instead.
*/
@Deprecated
@Override
public boolean remove(final Object o) {
if (o == null) return false;
return rem(((((Short)(o)).shortValue())));
}
@Override
public short[] toArray(short a[]) {
if (a == null || a.length < size()) a = new short[size()];
ShortIterators.unwrap(iterator(), a);
return a;
}
@Override
public short[] toShortArray() {
return toShortArray(null);
}
/* {@inheritDoc}
* @deprecated Please use {@code toArray()} instead—this method is redundant.
*/
@Deprecated
@Override
public short[] toShortArray(final short a[]) {
return toArray(a);
}
@Override
public boolean addAll(final ShortCollection c) {
boolean retVal = false;
for(final ShortIterator i = c.iterator(); i.hasNext();)
if (add(i.nextShort())) retVal = true;
return retVal;
}
@Override
public boolean containsAll(final ShortCollection c) {
for(final ShortIterator i = c.iterator(); i.hasNext();)
if (! contains(i.nextShort())) return false;
return true;
}
@Override
public boolean removeAll(final ShortCollection c) {
boolean retVal = false;
for(final ShortIterator i = c.iterator(); i.hasNext();)
if (rem(i.nextShort())) retVal = true;
return retVal;
}
@Override
public boolean retainAll(final ShortCollection c) {
boolean retVal = false;
for(final ShortIterator i = iterator(); i.hasNext();)
if (! c.contains(i.nextShort())) {
i.remove();
retVal = true;
}
return retVal;
}
@Override
public String toString() {
final StringBuilder s = new StringBuilder();
final ShortIterator i = iterator();
int n = size();
short k;
boolean first = true;
s.append("{");
while(n-- != 0) {
if (first) first = false;
else s.append(", ");
k = i.nextShort();
s.append(String.valueOf(k));
}
s.append("}");
return s.toString();
}
}