flexmark-all 0.64.8 · com.vladsch.flexmark.util.collection.OrderedSet

Modifier and Type	Class and Description
private class	OrderedSet.IndexedProxy

Modifier and Type	Field and Description
private @Nullable Indexed<E>	allowConcurrentModsIndexedProxy
private final @Nullable CollectionHost<E>	host
private @Nullable Indexed<E>	indexedProxy
private final @NotNull HashMap<E, Integer>	keyMap
private int	modificationCount
private final @NotNull BitSet	validIndices
pack-priv final @NotNull ArrayList<E>	valueList

Access	Constructor and Description
public	OrderedSet()
public	OrderedSet(int capacity)
public	OrderedSet(@NotNull CollectionHost<E> host)
public	OrderedSet(int capacity, @Nullable CollectionHost<E> host)

Method Summary

Modifier and Type	Method and Description
public boolean	add(E element to be added to this set e) Implements java.util.Set.add. Adds the specified element to this set if it is not already present (optional operation).
public boolean	add(E e, @Nullable Object o)
public boolean	addAll(@NotNull Collection<? extends E> collection containing elements to be added to this set collection) 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	addNull()
public void	addNulls(int index)
public void	clear() Implements java.util.Set.clear. Removes all of the elements from this set (optional operation).
public boolean	contains(@Nullable 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(@NotNull Collection<?> collection to be checked for containment in this set collection) Implements java.util.Set.containsAll. Returns `true` if this set contains all of the elements of the specified collection.
public @NotNull BitSet	differenceBitSet(@NotNull Iterable<? extends E> items)
public @NotNull BitSet	differenceBitSet(@NotNull Iterator<? extends E> items)
public boolean	equals(Object object to be compared for equality with this set o) Overrides java.lang.Object.equals. Implements java.util.Set.equals. Compares the specified object with this set for equality.
public @NotNull Indexed<E>	getConcurrentModsIndexedProxy()
public @NotNull Indexed<E>	getIndexedProxy()
pack-priv int	getIteratorModificationCount()
public int	getModificationCount()
public @NotNull BitSet	getValidIndices()
public E	getValue(int index)
public @NotNull List<E>	getValueList()
public E	getValueOrNull(int index)
public int	hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Set.hashCode. Returns the hash code value for this set.
public static <T1> T1	ifNull(T1 o, T1 nullValue)
public @NotNull BitSet	indexBitSet(@NotNull Iterable<? extends E> items)
public @NotNull ReversibleIterable<Integer>	indexIterable()
public @NotNull ReversibleIterator<Integer>	indexIterator()
public int	indexOf(@Nullable Object element)
public boolean	inHostUpdate()
public boolean	isEmpty() Implements java.util.Set.isEmpty. Returns `true` if this set contains no elements.
public boolean	isSparse()
public boolean	isValidIndex(int index)
public @NotNull ReversibleIterable<E>	iterable()
public @NotNull ReversibleIndexedIterator<E>	iterator() Implements java.util.Set.iterator, java.lang.Iterable.iterator. Returns an iterator over the elements in this set.
public @NotNull BitSet	keyDifferenceBitSet(@NotNull Iterable<? extends Map.Entry<? extends E, ?>> items)
public @NotNull BitSet	keyDifferenceBitSet(@NotNull Iterator<? extends Map.Entry<? extends E, ?>> items)
public boolean	remove(@Nullable 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(@NotNull Collection<?> collection containing elements to be removed from this set collection) Implements java.util.Set.removeAll. Removes from this set all of its elements that are contained in the specified collection (optional operation).
public @Nullable Object	removeHosted(@Nullable Object o)
public boolean	removeIndex(int index)
public Object	removeIndexHosted(int index)
public boolean	retainAll(@NotNull Collection<?> collection containing elements to be retained in this set collection) Implements java.util.Set.retainAll. Retains only the elements in this set that are contained in the specified collection (optional operation).
public @NotNull ReversibleIterable<Integer>	reversedIndexIterable()
public @NotNull ReversibleIterator<Integer>	reversedIndexIterator()
public @NotNull ReversibleIterable<E>	reversedIterable()
public @NotNull ReversibleIndexedIterator<E>	reversedIterator()
public boolean	setValueAt(int index, E value, @Nullable Object o)
public int	size() Implements java.util.Set.size. Returns the number of elements in this set (its cardinality).
public @NotNull Object[]	toArray() Implements java.util.Set.toArray. Returns an array containing all of the elements in this set.
public <T> T[]	toArray(T[] 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. array) 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 void	validateIndex(int index)
public @NotNull BitSet	valueDifferenceBitSet(@NotNull Iterable<? extends Map.Entry<?, ? extends E>> items)
public @NotNull BitSet	valueDifferenceBitSet(@NotNull Iterator<? extends Map.Entry<?, ? extends E>> items)
public @NotNull List<E>	values()

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

allowConcurrentModsIndexedProxy	back to summary
private @Nullable Indexed<E> allowConcurrentModsIndexedProxy Annotations @Nullable

host	back to summary
private final @Nullable CollectionHost<E> host Annotations @Nullable

indexedProxy	back to summary
private @Nullable Indexed<E> indexedProxy Annotations @Nullable

keyMap	back to summary
private final @NotNull HashMap<E, Integer> keyMap Annotations @NotNull

modificationCount	back to summary
private int modificationCount

validIndices	back to summary
private final @NotNull BitSet validIndices Annotations @NotNull

valueList	back to summary
pack-priv final @NotNull ArrayList<E> valueList Annotations @NotNull

OrderedSet	back to summary
public OrderedSet()

OrderedSet	back to summary
public OrderedSet(int capacity)

OrderedSet	back to summary
public OrderedSet(@NotNull CollectionHost<E> host)

OrderedSet	back to summary
public OrderedSet(int capacity, @Nullable CollectionHost<E> host)

Method Detail

add back to summary

add	back to summary
public boolean add(E e) Implements java.util.Set.add. Doc from java.util.Set.add. Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element `e` to this set if the set contains no element `e2` such that `Objects.equals(e, e2)`. If this set already contains the element, the call leaves the set unchanged and returns `false`. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements. The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including `null`, and throw an exception, as described in the specification for `Collection.add`. Individual set implementations should clearly document any restrictions on the elements that they may contain. Parameters e:E element to be added to this set Returns:boolean `true` if this set did not already contain the specified element Annotations @Override

public boolean add(E e)

Implements java.util.Set.add.

Doc from java.util.Set.add.

Adds the specified element to this set if it is not already present (optional operation). More formally, adds the specified element e to this set if the set contains no element e2 such that Objects.equals(e, e2). If this set already contains the element, the call leaves the set unchanged and returns false. In combination with the restriction on constructors, this ensures that sets never contain duplicate elements.

The stipulation above does not imply that sets must accept all elements; sets may refuse to add any particular element, including null, and throw an exception, as described in the specification for Collection.add. Individual set implementations should clearly document any restrictions on the elements that they may contain.

Parameters

e:E: element to be added to this set

Returns:boolean

true if this set did not already contain the specified element

Annotations

@Override

add	back to summary
public boolean add(E e, @Nullable Object o)

addAll back to summary

addAll	back to summary
public boolean addAll(@NotNull Collection<? extends E> collection) 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 collection:@NotNull Collection<? extends E> 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(@NotNull Collection<? extends E> collection)

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

collection:@NotNull Collection<? extends E>: collection containing elements to be added to this set

Returns:boolean

true if this set changed as a result of the call

Annotations

@Override

addNull	back to summary
public void addNull()

addNulls	back to summary
public void addNulls(int index)

clear	back to summary
public void clear() Implements java.util.Set.clear. Doc from java.util.Set.clear. Removes all of the elements from this set (optional operation). The set will be empty after this call returns. Annotations @Override

clear

back to summary

public void clear()

Implements java.util.Set.clear.

Doc from java.util.Set.clear.

Removes all of the elements from this set (optional operation). The set will be empty after this call returns.

Annotations

@Override

contains back to summary

contains	back to summary
public boolean contains(@Nullable 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:@Nullable 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(@Nullable 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:@Nullable 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(@NotNull Collection<?> collection) 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 collection:@NotNull 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(@NotNull Collection<?> collection)

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

collection:@NotNull 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

differenceBitSet	back to summary
public @NotNull BitSet differenceBitSet(@NotNull Iterable<? extends E> items) Annotations @NotNull

differenceBitSet	back to summary
public @NotNull BitSet differenceBitSet(@NotNull Iterator<? extends E> items) Annotations @NotNull

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Implements java.util.Set.equals. Doc from java.util.Set.equals. Compares the specified object with this set for equality. Returns `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. Parameters o:Object object to be compared for equality with this set Returns:boolean `true` if the specified object is equal to this set Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Implements java.util.Set.equals.

Doc from java.util.Set.equals.

Compares the specified object with this set for equality. Returns 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.

Parameters

o:Object: object to be compared for equality with this set

Returns:boolean

true if the specified object is equal to this set

Annotations

@Override

getConcurrentModsIndexedProxy	back to summary
public @NotNull Indexed<E> getConcurrentModsIndexedProxy() Annotations @NotNull

getIndexedProxy	back to summary
public @NotNull Indexed<E> getIndexedProxy() Annotations @NotNull

getIteratorModificationCount	back to summary
pack-priv int getIteratorModificationCount()

getModificationCount	back to summary
public int getModificationCount()

getValidIndices	back to summary
public @NotNull BitSet getValidIndices() Annotations @NotNull

getValue	back to summary
public E getValue(int index) Annotations @Nullable

getValueList	back to summary
public @NotNull List<E> getValueList() Annotations @NotNull

getValueOrNull	back to summary
public E getValueOrNull(int index) Annotations @Nullable

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Set.hashCode. Doc from java.util.Set.hashCode. 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 elements in the set, where the hash code of a `null` element is defined to be zero. This ensures that `s1.equals(s2)` implies that `s1.hashCode()==s2.hashCode()` for any two sets `s1` and `s2`, as required by the general contract of `Object#hashCode`. Returns:int the hash code value for this set Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Set.hashCode.

Doc from java.util.Set.hashCode.

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 elements in the set, where the hash code of a null element is defined to be zero. This ensures that s1.equals(s2) implies that s1.hashCode()==s2.hashCode() for any two sets s1 and s2, as required by the general contract of Object#hashCode.

Returns:int

the hash code value for this set

Annotations

@Override

ifNull	back to summary
public static <T1> T1 ifNull(T1 o, T1 nullValue)

indexBitSet	back to summary
public @NotNull BitSet indexBitSet(@NotNull Iterable<? extends E> items) Annotations @NotNull

indexIterable	back to summary
public @NotNull ReversibleIterable<Integer> indexIterable() Annotations @NotNull

indexIterator	back to summary
public @NotNull ReversibleIterator<Integer> indexIterator() Annotations @NotNull

indexOf	back to summary
public int indexOf(@Nullable Object element)

inHostUpdate	back to summary
public boolean inHostUpdate()

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

isSparse	back to summary
public boolean isSparse() Annotations @SuppressWarnings:BooleanMethodIsAlwaysInverted

isValidIndex	back to summary
public boolean isValidIndex(int index)

iterable	back to summary
public @NotNull ReversibleIterable<E> iterable() Annotations @NotNull

iterator	back to summary
public @NotNull ReversibleIndexedIterator<E> iterator() Implements java.util.Set.iterator, java.lang.Iterable.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:@NotNull ReversibleIndexedIterator<E> an iterator over the elements in this set Annotations @Override @NotNull

iterator

back to summary

public @NotNull ReversibleIndexedIterator<E> iterator()

Implements java.util.Set.iterator, java.lang.Iterable.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:@NotNull ReversibleIndexedIterator<E>

an iterator over the elements in this set

Annotations

@Override
@NotNull

keyDifferenceBitSet	back to summary
public @NotNull BitSet keyDifferenceBitSet(@NotNull Iterable<? extends Map.Entry<? extends E, ?>> items) Annotations @NotNull

keyDifferenceBitSet	back to summary
public @NotNull BitSet keyDifferenceBitSet(@NotNull Iterator<? extends Map.Entry<? extends E, ?>> items) Annotations @NotNull

remove back to summary

remove	back to summary
public boolean remove(@Nullable 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:@Nullable Object object to be removed from this set, if present Returns:boolean `true` if this set contained the specified element Annotations @Override

public boolean remove(@Nullable 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:@Nullable Object: object to be removed from this set, if present

Returns:boolean

true if this set contained the specified element

Annotations

@Override

removeAll back to summary

removeAll	back to summary
public boolean removeAll(@NotNull Collection<?> collection) 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 collection:@NotNull 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(@NotNull Collection<?> collection)

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

collection:@NotNull 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

removeHosted	back to summary
public @Nullable Object removeHosted(@Nullable Object o) Annotations @Nullable

removeIndex	back to summary
public boolean removeIndex(int index)

removeIndexHosted	back to summary
public Object removeIndexHosted(int index)

retainAll back to summary

public boolean retainAll(@NotNull Collection<?> collection)

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

collection:@NotNull 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

reversedIndexIterable	back to summary
public @NotNull ReversibleIterable<Integer> reversedIndexIterable() Annotations @NotNull

reversedIndexIterator	back to summary
public @NotNull ReversibleIterator<Integer> reversedIndexIterator() Annotations @NotNull

reversedIterable	back to summary
public @NotNull ReversibleIterable<E> reversedIterable() Annotations @NotNull

reversedIterator	back to summary
public @NotNull ReversibleIndexedIterator<E> reversedIterator() Annotations @NotNull

setValueAt	back to summary
public boolean setValueAt(int index, E value, @Nullable Object o)

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

toArray

back to summary

public @NotNull 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:@NotNull Object[]

an array containing all the elements in this set

Annotations

@NotNull
@Override

toArray back to summary

public <T> T[] toArray(T[] array)

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

<T>: Doc from java.util.Collection.toArray. the component type of the array to contain the collection
array:T[]: 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:T[]

an array containing all the elements in this set

Annotations

@NotNull
@Override

validateIndex	back to summary
public void validateIndex(int index)

valueDifferenceBitSet	back to summary
public @NotNull BitSet valueDifferenceBitSet(@NotNull Iterable<? extends Map.Entry<?, ? extends E>> items) Annotations @NotNull

valueDifferenceBitSet	back to summary
public @NotNull BitSet valueDifferenceBitSet(@NotNull Iterator<? extends Map.Entry<?, ? extends E>> items) Annotations @NotNull

values	back to summary
public @NotNull List<E> values() Annotations @NotNull

public Class OrderedSet<E>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class OrderedSet.IndexedProxy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public E	get(int index) Implements com.vladsch.flexmark.util.collection.iteration.Indexed.get.
public int	modificationCount() Implements com.vladsch.flexmark.util.collection.iteration.Indexed.modificationCount.
public void	removeAt(int index) Implements com.vladsch.flexmark.util.collection.iteration.Indexed.removeAt.
public void	set(int index, E item) Implements com.vladsch.flexmark.util.collection.iteration.Indexed.set.
public int	size() Implements com.vladsch.flexmark.util.collection.iteration.Indexed.size.