it.unimi.dsi.fastutil.booleans.BooleanCollection Maven / Gradle / Ivy
Show all versions of fastutil Show documentation
/*
* 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.booleans;
import java.util.Collection;
/**
* A type-specific {@link Collection}; provides some additional methods that use
* polymorphism to avoid (un)boxing.
*
*
* Additionally, this class defines strengthens (again) {@link #iterator()}.
*
* @see Collection
*/
public interface BooleanCollection extends Collection, BooleanIterable {
/**
* Returns a type-specific iterator on the elements of this collection.
*
*
* 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 Collection}.
*
* @return a type-specific iterator on the elements of this collection.
*/
@Override
BooleanIterator iterator();
/**
* Ensures that this collection contains the specified element (optional
* operation).
*
* @see Collection#add(Object)
*/
boolean add(boolean key);
/**
* Returns {@code true} if this collection contains the specified element.
*
* @see Collection#contains(Object)
*/
boolean contains(boolean key);
/**
* Removes a single instance of the specified element from this collection, if
* it is present (optional operation).
*
*
* Note that this method should be called
* {@link java.util.Collection#remove(Object) remove()}, but the clash with the
* similarly named index-based method in the {@link java.util.List} interface
* forces us to use a distinguished name. For simplicity, the set interfaces
* reinstates {@code remove()}.
*
* @see Collection#remove(Object)
*/
boolean rem(boolean key);
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
default boolean add(final Boolean key) {
return add((key).booleanValue());
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
default boolean contains(final Object key) {
if (key == null)
return false;
return contains(((Boolean) (key)).booleanValue());
}
/**
* {@inheritDoc}
*
* @deprecated Please use (and implement) the {@code rem()} method instead.
*/
@Deprecated
@Override
default boolean remove(final Object key) {
if (key == null)
return false;
return rem(((Boolean) (key)).booleanValue());
}
/**
* Returns a primitive type array containing the items of this collection.
*
* @return a primitive type array containing the items of this collection.
* @see Collection#toArray()
*/
boolean[] toBooleanArray();
/**
* Returns a primitive type array containing the items of this collection.
*
*
* Note that, contrarily to {@link Collection#toArray(Object[])}, this methods
* just writes all elements of this collection: no special value will be added
* after the last one.
*
* @param a
* if this array is big enough, it will be used to store this
* collection.
* @return a primitive type array containing the items of this collection.
* @see Collection#toArray(Object[])
* @deprecated Please use {@code toArray()} instead—this method is
* redundant and will be removed in the future.
*/
@Deprecated
boolean[] toBooleanArray(boolean a[]);
/**
* Returns an array containing all of the elements in this collection; the
* runtime type of the returned array is that of the specified array.
*
*
* Note that, contrarily to {@link Collection#toArray(Object[])}, this methods
* just writes all elements of this collection: no special value will be added
* after the last one.
*
* @param a
* if this array is big enough, it will be used to store this
* collection.
* @return a primitive type array containing the items of this collection.
* @see Collection#toArray(Object[])
*/
boolean[] toArray(boolean a[]);
/**
* Adds all elements of the given type-specific collection to this collection.
*
* @param c
* a type-specific collection.
* @see Collection#addAll(Collection)
* @return {@code true} if this collection changed as a result of the call.
*/
boolean addAll(BooleanCollection c);
/**
* Checks whether this collection contains all elements from the given
* type-specific collection.
*
* @param c
* a type-specific collection.
* @see Collection#containsAll(Collection)
* @return {@code true} if this collection contains all elements of the
* argument.
*/
boolean containsAll(BooleanCollection c);
/**
* Remove from this collection all elements in the given type-specific
* collection.
*
* @param c
* a type-specific collection.
* @see Collection#removeAll(Collection)
* @return {@code true} if this collection changed as a result of the call.
*/
boolean removeAll(BooleanCollection c);
/**
* Retains in this collection only elements from the given type-specific
* collection.
*
* @param c
* a type-specific collection.
* @see Collection#retainAll(Collection)
* @return {@code true} if this collection changed as a result of the call.
*/
boolean retainAll(BooleanCollection c);
}