drv.Set.drv 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 PACKAGE;
import java.util.Set;
/** A type-specific {@link Set}; provides some additional methods that use polymorphism to avoid (un)boxing.
*
* Additionally, this interface strengthens (again) {@link #iterator()}.
*
* @see Set
*/
public interface SET KEY_GENERIC extends COLLECTION KEY_GENERIC, Set {
/** Returns a type-specific iterator on the elements of this set.
*
* Note that this specification strengthens the one given in {@link java.lang.Iterable#iterator()},
* which was already strengthened in the corresponding type-specific class,
* but was weakened by the fact that this interface extends {@link Set}.
*
* @return a type-specific iterator on the elements of this set.
*/
@Override
KEY_ITERATOR KEY_GENERIC iterator();
#if KEYS_PRIMITIVE
/** Removes an element from this set.
*
*
Note that the corresponding method of a type-specific collection is {@code rem()}.
* This unfortunate situation is caused by the clash
* with the similarly named index-based method in the {@link java.util.List} interface.
*
* @see java.util.Collection#remove(Object)
*/
public boolean remove(KEY_TYPE k);
/** Removes an element from this set.
*
*
This method is inherited from the type-specific collection this
* type-specific set is based on, but it should not used as
* this interface reinstates {@code remove()} as removal method.
*
* @deprecated please use {@code remove()} instead.
*/
@Deprecated
@Override
public boolean rem(KEY_TYPE k);
/** {@inheritDoc}
*
This method specification is a workaround for
* bug 8177440.
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
boolean add(KEY_GENERIC_CLASS key);
/** {@inheritDoc}
*
This method specification is a workaround for
* bug 8177440.
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
boolean contains(Object key);
/** {@inheritDoc}
*
This method specification is a workaround for
* bug 8177440.
* @deprecated Please use (and implement) the {@code rem()} method instead.
*/
@Deprecated
@Override
boolean remove(Object key);
#endif
}