.0.9.1.source-code.LongSet Maven / Gradle / Ivy
Show all versions of util Show documentation
/* Copyright (c) 2018 LibJ
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* You should have received a copy of The MIT License (MIT) along with this
* program. If not, see
* This interface is a replica of the {@link java.util.Set} interface that defines
* synonymous methods for a list of {@code long} values instead of Object
* references.
*/
@Generated(value="org.openjax.codegen.template.Templates", date="2024-02-27T13:50:20.763")
public interface LongSet extends LongCollection {
/**
* Adds the specified value to this set if it is not already present. More
* formally, adds the specified value {@code value} to this set if the set
* contains no value {@code value2} such that {@code value == value2}. If this
* set already contains the value, the call leaves the set unchanged and
* returns {@code false}. In combination with the restriction on constructors,
* this ensures that sets never contain duplicate values.
*
* @param value Value to be added to this set.
* @return {@code true} if this set did not already contain the specified
* value.
*/
@Override
boolean add(long value);
/**
* Adds all of the values in the specified collection to this set if they're
* not already present. If the specified collection is also a set, the
* {@code addAll} operation effectively modifies this set so that its value is
* the union of the two sets. The behavior of this operation is
* undefined if the specified collection is modified while the operation is in
* progress.
*
* @param c Collection containing values to be added to this set.
* @return {@code true} if this set changed as a result of the call.
* @throws ClassCastException If the class of an element of the specified
* collection is not {@link Long}.
* @throws NullPointerException If the specified collection contains one or
* more null values, or if the specified collection is null.
* @see #addAll(LongCollection)
* @see #add(long)
*/
@Override
boolean addAll(Collection c);
/**
* Adds all of the values in the specified collection to this set if they're
* not already present. If the specified collection is also a set, the
* {@code addAll} operation effectively modifies this set so that its value is
* the union of the two sets. The behavior of this operation is
* undefined if the specified collection is modified while the operation is in
* progress.
*
* @param c Collection containing values to be added to this set.
* @return {@code true} if this set changed as a result of the call.
* @throws NullPointerException If the specified collection contains one or
* more null values, or if the specified collection is null.
* @see #addAll(Collection)
* @see #add(long)
*/
@Override
boolean addAll(LongCollection c);
/**
* Returns {@code true} if this set contains the specified value. More
* formally, returns {@code true} if and only if this set contains a value
* {@code v} such that {@code Objects.equals(value, v)}.
*
* @param value Value whose presence in this set is to be tested.
* @return {@code true} if this set contains the specified value.
*/
@Override
boolean contains(long value);
/**
* Returns {@code true} if this set contains all of the values of the
* specified collection. If the specified collection is also a set, this
* method returns {@code true} if it is a subset of this set.
*
* @param c Collection to be checked for containment in this set.
* @return {@code true} if this set contains all of the values of the
* specified collection.
* @throws ClassCastException If the class of an element of the specified
* collection is not {@link Long}.
* @throws NullPointerException If the specified collection contains one or
* more null values, or if the specified collection is null.
* @see #containsAll(LongCollection)
* @see #contains(long)
*/
@Override
boolean containsAll(Collection c);
/**
* Returns {@code true} if this set contains all of the values of the
* specified collection. If the specified collection is also a set, this
* method returns {@code true} if it is a subset of this set.
*
* @param c Collection to be checked for containment in this set.
* @return {@code true} if this set contains all of the values of the
* specified collection.
* @see #containsAll(Collection)
* @see #contains(long)
*/
@Override
boolean containsAll(LongCollection c);
/**
* Removes the specified value from this set if it is present. More formally,
* removes an value {@code v} such that {@code Objects.equals(value, v)}, if
* this set contains such an value. Returns {@code true} if this set contained
* the value (or equivalently, if this set changed as a result of the call).
* (This set will not contain the value once the call returns).
*
* @param value Value to be removed from this set, if present.
* @return {@code true} if this set contained the specified value.
*/
@Override
boolean remove(long value);
/**
* Removes from this set all of its values that are contained in the specified
* collection. If the specified collection is also a set, this operation
* effectively modifies this set so that its value is the asymmetric set
* difference of the two sets.
*
* @param c Collection containing values to be removed from this set.
* @return {@code true} if this set changed as a result of the call.
* @throws ClassCastException If the class of an element of the specified
* collection is not {@link Long}.
* @throws NullPointerException If the specified collection contains a null
* value, or if the specified collection is null.
* @see #removeAll(LongCollection)
* @see #remove(long)
* @see #contains(long)
*/
@Override
boolean removeAll(Collection c);
/**
* Removes from this set all of its values that are contained in the specified
* collection. If the specified collection is also a set, this operation
* effectively modifies this set so that its value is the asymmetric set
* difference of the two sets.
*
* @param c Collection containing values to be removed from this set.
* @return {@code true} if this set changed as a result of the call.
* @throws NullPointerException If the specified collection contains a null
* value, or if the specified collection is null.
* @see #removeAll(Collection)
* @see #remove(long)
* @see #contains(long)
*/
@Override
boolean removeAll(LongCollection c);
/**
* Retains only the values in this set that are contained in the specified
* collection. In other words, removes from this set all of its values that
* are not contained in the specified collection. If the specified collection
* is also a set, this operation effectively modifies this set so that its
* value is the intersection of the two sets.
*
* @param c Collection containing values to be retained in this set.
* @return {@code true} if this set changed as a result of the call.
* @throws ClassCastException If the class of an element of the specified
* collection is not {@link Long}.
* @throws NullPointerException If the specified collection contains a null
* value, or if the specified collection is null.
* @see #retainAll(LongCollection)
* @see #remove(long)
* @see #contains(long)
*/
@Override
boolean retainAll(Collection c);
/**
* Retains only the values in this set that are contained in the specified
* collection. In other words, removes from this set all of its values that
* are not contained in the specified collection. If the specified collection
* is also a set, this operation effectively modifies this set so that its
* value is the intersection of the two sets.
*
* @param c Collection containing values to be retained in this set.
* @return {@code true} if this set changed as a result of the call.
* @throws NullPointerException If the specified collection contains a null
* value, or if the specified collection is null.
* @see #retainAll(Collection)
* @see #remove(long)
* @see #contains(long)
*/
@Override
boolean retainAll(LongCollection c);
/**
* Removes all of the values from this set. The set will be empty after this
* call returns.
*/
@Override
void clear();
/**
* Returns the number of values in this set (its cardinality). If this set
* contains more than {@link Long#MAX_VALUE} values, returns
* {@link Long#MAX_VALUE}.
*
* @return The number of values in this set (its cardinality).
*/
@Override
int size();
/**
* Returns {@code true} if this set contains no values.
*
* @return {@code true} if this set contains no values.
*/
@Override
boolean isEmpty();
/**
* Returns an iterator over the values in this set. The values are returned in
* no particular order (unless this set is an instance of some class that
* provides a guarantee).
*
* @return An iterator over the values in this set.
*/
@Override
LongIterator iterator();
/**
* Creates a {@code Spliterator.OfLong} over the elements in this set.
*
* The {@code Spliterator.OfLong} reports {@link Spliterator#DISTINCT}.
*
* @return A {@code Spliterator.OfLong} over the elements in this set.
* @see java.util.Spliterator.OfLong
*/
@Override
Spliterator.OfLong spliterator();
/**
* Compares the specified object with this set for equality. Returns
* {@code true} if the specified object is also a set, the two sets have the
* same size, and every member of the specified set is contained in this set
* (or equivalently, every member of this set is contained in the specified
* set). This definition ensures that the equals method works properly across
* different implementations of the set interface.
*
* @param obj Object to be compared for equality with this set.
* @return {@code true} if the specified object is equal to this set.
*/
@Override
boolean equals(Object obj);
/**
* Returns the hash code value for this set. The hash code of a set is defined
* to be the sum of the hash codes of the values in the set. This ensures that
* {@code s1 == s2} implies that {@code s1.hashCode() == s2.hashCode()} for
* any two sets {@code s1} and {@code s2}, as required by the general contract
* of {@link Object#hashCode}.
*
* @return The hash code value for this set.
* @see Object#equals(Object)
* @see LongSet#equals(Object)
*/
@Override
int hashCode();
}