junixsocket 2.10.1 · org.newsclub.net.unix.MapValueSet

Modifier and Type	Class and Description
pack-priv static interface	MapValueSet.ValueSupplier<V>

Modifier and Type	Field and Description
private final Map<T, V>	map
private final V	removedSentinel
private final MapValueSet.ValueSupplier<@NonNull V>	valueSupplier

Access	Constructor and Description
pack-priv	MapValueSet(Map<? extends T, V> map, MapValueSet.ValueSupplier<@NonNull V> valueSupplier, V removedSentinel)

Method Summary

Modifier and Type	Method and Description
public boolean	add(T element to be added to this set e) Implements java.util.Set.add. Adds an entry to the set, adding it to the backing map if necessary.
public boolean	addAll(Collection<? extends T> collection containing elements to be added to this set c) Implements java.util.Set.addAll. Adds all of the elements in the specified collection to this set if they're not already present (optional operation).
public void	clear() Implements java.util.Set.clear. Marks all entries in the backing map that are currently considered contained in this set as removed; see `markAllRemoved()` for an unoptimized version that affects all keys.
public boolean	contains(Object element whose presence in this set is to be tested o) Implements java.util.Set.contains. Returns `true` if this set contains the specified element.
public boolean	containsAll(Collection<?> collection to be checked for containment in this set c) Implements java.util.Set.containsAll. Returns `true` if this set contains all of the elements of the specified collection.
private @NonNull V	getValue()
private boolean	isDefinitelyEmpty()
public boolean	isEmpty() Implements java.util.Set.isEmpty. Returns `true` if this set contains no elements.
public Iterator<T>	iterator() Implements java.util.Set.iterator. Returns an iterator over the elements in this set.
public void	markAllRemoved() Sets all entries in the backing map to the "removed" sentinel, or removes them all if that value is `null`.
public void	markRemoved(T The element to remove. elem) Marks the given element as "removed"; this may actually add an element to the underlying map.
public boolean	remove(Object object to be removed from this set, if present o) Implements java.util.Set.remove. Removes the specified element from this set if it is present (optional operation).
public boolean	removeAll(Collection<?> collection containing elements to be removed from this set c) Implements java.util.Set.removeAll. Removes from this set all of its elements that are contained in the specified collection (optional operation).
public boolean	retainAll(Collection<?> collection containing elements to be retained in this set c) Implements java.util.Set.retainAll. Retains only the elements in this set that are contained in the specified collection (optional operation).
public int	size() Implements java.util.Set.size. Returns the number of elements in this set (its cardinality).
public Object[]	toArray() Implements java.util.Set.toArray. Returns an array containing all of the elements in this set.
public <E> E[]	toArray(E[] the array into which the elements of this set are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose. a) Implements java.util.Set.toArray. Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array.
public boolean	update(T The entry to update. e) Updates an already-existing entry in the backing map to the current value (obtained via `getValue()`), thereby adding it to the set.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

map	back to summary
private final Map<T, V> map

removedSentinel	back to summary
private final V removedSentinel

valueSupplier	back to summary
private final MapValueSet.ValueSupplier<@NonNull V> valueSupplier

MapValueSet	back to summary
pack-priv MapValueSet(Map<? extends T, V> map, MapValueSet.ValueSupplier<@NonNull V> valueSupplier, V removedSentinel) Annotations @SuppressWarnings:unchecked

Method Detail

add back to summary

add	back to summary
public boolean add(T e) Implements java.util.Set.add. Adds an entry to the set, adding it to the backing map if necessary. Parameters e:T Doc from java.util.Set.add. element to be added to this set Returns:boolean Doc from java.util.Set.add. `true` if this set did not already contain the specified element Annotations @Override

public boolean add(T e)

Implements java.util.Set.add.

Adds an entry to the set, adding it to the backing map if necessary.

Parameters

e:T

Doc from java.util.Set.add.

element to be added to this set

Returns:boolean

Doc from java.util.Set.add.

true if this set did not already contain the specified element

Annotations

@Override

addAll back to summary

addAll	back to summary
public boolean addAll(Collection<? extends T> c) Implements java.util.Set.addAll. Doc from java.util.Set.addAll. Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the `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. Parameters c:Collection<? extends T> collection containing elements to be added to this set Returns:boolean `true` if this set changed as a result of the call Annotations @Override

public boolean addAll(Collection<? extends T> c)

Implements java.util.Set.addAll.

Doc from java.util.Set.addAll.

Adds all of the elements in the specified collection to this set if they're not already present (optional operation). If the specified collection is also a set, the 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.

Parameters

c:Collection<? extends T>: collection containing elements to be added to this set

Returns:boolean

true if this set changed as a result of the call

Annotations

@Override

clear back to summary

clear	back to summary
public void clear() Implements java.util.Set.clear. Marks all entries in the backing map that are currently considered contained in this set as removed; see `markAllRemoved()` for an unoptimized version that affects all keys. Annotations @Override See Also `markAllRemoved()`

public void clear()

Implements java.util.Set.clear.

Marks all entries in the backing map that are currently considered contained in this set as removed; see markAllRemoved() for an unoptimized version that affects all keys.

Annotations

@Override

See Also

markAllRemoved()

contains back to summary

contains	back to summary
public boolean contains(Object o) Implements java.util.Set.contains. Doc from java.util.Set.contains. Returns `true` if this set contains the specified element. More formally, returns `true` if and only if this set contains an element `e` such that `Objects.equals(o, e)`. Parameters o:Object element whose presence in this set is to be tested Returns:boolean `true` if this set contains the specified element Annotations @Override

public boolean contains(Object o)

Implements java.util.Set.contains.

Doc from java.util.Set.contains.

Returns true if this set contains the specified element. More formally, returns true if and only if this set contains an element e such that Objects.equals(o, e).

Parameters

o:Object: element whose presence in this set is to be tested

Returns:boolean

true if this set contains the specified element

Annotations

@Override

containsAll back to summary

containsAll	back to summary
public boolean containsAll(Collection<?> c) Implements java.util.Set.containsAll. Doc from java.util.Set.containsAll. Returns `true` if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns `true` if it is a subset of this set. Parameters c:Collection<?> collection to be checked for containment in this set Returns:boolean `true` if this set contains all of the elements of the specified collection Annotations @Override

public boolean containsAll(Collection<?> c)

Implements java.util.Set.containsAll.

Doc from java.util.Set.containsAll.

Returns true if this set contains all of the elements of the specified collection. If the specified collection is also a set, this method returns true if it is a subset of this set.

Parameters

c:Collection<?>: collection to be checked for containment in this set

Returns:boolean

true if this set contains all of the elements of the specified collection

Annotations

@Override

getValue	back to summary
private @NonNull V getValue()

isDefinitelyEmpty	back to summary
private boolean isDefinitelyEmpty()

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Implements java.util.Set.isEmpty. Doc from java.util.Set.isEmpty. Returns `true` if this set contains no elements. Returns:boolean `true` if this set contains no elements Annotations @Override

public boolean isEmpty()

Implements java.util.Set.isEmpty.

Doc from java.util.Set.isEmpty.

Returns true if this set contains no elements.

Returns:boolean

true if this set contains no elements

Annotations

@Override

iterator	back to summary
public Iterator<T> iterator() Implements java.util.Set.iterator. Doc from java.util.Set.iterator. Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee). Returns:Iterator<T> an iterator over the elements in this set Annotations @Override

iterator

back to summary

public Iterator<T> iterator()

Implements java.util.Set.iterator.

Doc from java.util.Set.iterator.

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

Returns:Iterator<T>

an iterator over the elements in this set

Annotations

@Override

markAllRemoved	back to summary
public void markAllRemoved() Sets all entries in the backing map to the "removed" sentinel, or removes them all if that value is `null`.

markRemoved	back to summary
public void markRemoved(T elem) Marks the given element as "removed"; this may actually add an element to the underlying map. Depending on the "removed" sentinel, the key may be added (if value is non-null but the map does not yet contain the key), modified (value is non-null, and the map has a different value for the key), or removed (if value is null). Parameters elem:T The element to remove.

markRemoved

back to summary

public void markRemoved(T elem)

Marks the given element as "removed"; this may actually add an element to the underlying map.

Depending on the "removed" sentinel, the key may be added (if value is non-null but the map does not yet contain the key), modified (value is non-null, and the map has a different value for the key), or removed (if value is null).

Parameters

elem:T: The element to remove.

remove back to summary

remove	back to summary
public boolean remove(Object o) Implements java.util.Set.remove. Doc from java.util.Set.remove. Removes the specified element from this set if it is present (optional operation). More formally, removes an element `e` such that `Objects.equals(o, e)`, if this set contains such an element. Returns `true` if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.) Parameters o:Object object to be removed from this set, if present Returns:boolean `true` if this set contained the specified element Annotations @SuppressWarnings:unchecked @Override

public boolean remove(Object o)

Implements java.util.Set.remove.

Doc from java.util.Set.remove.

Removes the specified element from this set if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this set contains such an element. Returns true if this set contained the element (or equivalently, if this set changed as a result of the call). (This set will not contain the element once the call returns.)

Parameters

o:Object: object to be removed from this set, if present

Returns:boolean

true if this set contained the specified element

Annotations

@SuppressWarnings:unchecked
@Override

removeAll back to summary

removeAll	back to summary
public boolean removeAll(Collection<?> c) Implements java.util.Set.removeAll. Doc from java.util.Set.removeAll. Removes from this set all of its elements that are contained in the specified collection (optional operation). 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. Parameters c:Collection<?> collection containing elements to be removed from this set Returns:boolean `true` if this set changed as a result of the call Annotations @Override

public boolean removeAll(Collection<?> c)

Implements java.util.Set.removeAll.

Doc from java.util.Set.removeAll.

Removes from this set all of its elements that are contained in the specified collection (optional operation). 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.

Parameters

c:Collection<?>: collection containing elements to be removed from this set

Returns:boolean

true if this set changed as a result of the call

Annotations

@Override

retainAll back to summary

retainAll	back to summary
public boolean retainAll(Collection<?> c) Implements java.util.Set.retainAll. Doc from java.util.Set.retainAll. Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements 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. Parameters c:Collection<?> collection containing elements to be retained in this set Returns:boolean `true` if this set changed as a result of the call Annotations @Override

public boolean retainAll(Collection<?> c)

Implements java.util.Set.retainAll.

Doc from java.util.Set.retainAll.

Retains only the elements in this set that are contained in the specified collection (optional operation). In other words, removes from this set all of its elements 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.

Parameters

c:Collection<?>: collection containing elements to be retained in this set

Returns:boolean

true if this set changed as a result of the call

Annotations

@Override

size back to summary

size	back to summary
public int size() Implements java.util.Set.size. Doc from java.util.Set.size. Returns the number of elements in this set (its cardinality). If this set contains more than `Integer.MAX_VALUE` elements, returns `Integer.MAX_VALUE`. Returns:int the number of elements in this set (its cardinality) Annotations @Override

public int size()

Implements java.util.Set.size.

Doc from java.util.Set.size.

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of elements in this set (its cardinality)

Annotations

@Override

toArray	back to summary
public Object[] toArray() Implements java.util.Set.toArray. Doc from java.util.Set.toArray. Returns an array containing all of the elements in this set. If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array will be "safe" in that no references to it are maintained by this set. (In other words, this method must allocate a new array even if this set is backed by an array). The caller is thus free to modify the returned array. This method acts as bridge between array-based and collection-based APIs. Returns:Object[] an array containing all the elements in this set Annotations @Override @SuppressWarnings:PMD.OptimizableToArrayCall

toArray

back to summary

public Object[] toArray()

Implements java.util.Set.toArray.

Doc from java.util.Set.toArray.

Returns an array containing all of the elements in this set. If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

The returned array will be "safe" in that no references to it are maintained by this set. (In other words, this method must allocate a new array even if this set is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Returns:Object[]

an array containing all the elements in this set

Annotations

@Override
@SuppressWarnings:PMD.OptimizableToArrayCall

toArray back to summary

toArray	back to summary
public <E> E[] toArray(E[] a) Implements java.util.Set.toArray. Doc from java.util.Set.toArray. Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array. If the set fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this set. If this set fits in the specified array with room to spare (i.e., the array has more elements than this set), the element in the array immediately following the end of the set is set to `null`. (This is useful in determining the length of this set only if the caller knows that this set does not contain any null elements.) If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. Like the `toArray()` method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs. Suppose `x` is a set known to contain only strings. The following code can be used to dump the set into a newly allocated array of `String`: String[] y = x.toArray(new String[0]); Note that `toArray(new Object[0])` is identical in function to `toArray()`. Parameters <E> Doc from java.util.Collection.toArray. the component type of the array to contain the collection a:E[] the array into which the elements of this set are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose. Returns:E[] an array containing all the elements in this set Annotations @SuppressWarnings:unchecked, null @Override

public <E> E[] toArray(E[] a)

Implements java.util.Set.toArray.

Doc from java.util.Set.toArray.

Returns an array containing all of the elements in this set; the runtime type of the returned array is that of the specified array. If the set fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this set.

If this set fits in the specified array with room to spare (i.e., the array has more elements than this set), the element in the array immediately following the end of the set is set to null. (This is useful in determining the length of this set only if the caller knows that this set does not contain any null elements.)

If this set makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order.

Like the toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.

Suppose x is a set known to contain only strings. The following code can be used to dump the set into a newly allocated array of String:

    String[] y = x.toArray(new String[0]);

Note that toArray(new Object[0]) is identical in function to toArray().

Parameters

<E>: Doc from java.util.Collection.toArray. the component type of the array to contain the collection
a:E[]: the array into which the elements of this set are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:E[]

an array containing all the elements in this set

Annotations

@SuppressWarnings:unchecked, null
@Override

update back to summary

update	back to summary
public boolean update(T e) Updates an already-existing entry in the backing map to the current value (obtained via `getValue()`), thereby adding it to the set. Parameters e:T The entry to update.

public boolean update(T e)

Updates an already-existing entry in the backing map to the current value (obtained via getValue()), thereby adding it to the set.

Parameters

e:T: The entry to update.

pack-priv final Class MapValueSet<T, V>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface MapValueSet.ValueSupplier<V>

Method Summary

Method Detail