Class ByteImmutableList
- All Implemented Interfaces:
ByteCollection,ByteIterable,ByteList,ByteStack,Stack<Byte>,Serializable,Cloneable,Comparable<List<? extends Byte>>,Iterable<Byte>,Collection<Byte>,List<Byte>,RandomAccess,SequencedCollection<Byte>
Instances of this class are immutable and (contrarily to mutable array-based list implementations) the backing array is not exposed. Instances can be built using a variety of methods, but note that constructors using an array will not make a defensive copy.
This class implements the bulk method getElements() using high-performance system calls
(e.g., System.arraycopy()) instead of
expensive loops.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteList
AbstractByteList.ByteRandomAccessSubList, AbstractByteList.ByteSubList -
Constructor Summary
ConstructorsConstructorDescriptionByteImmutableList(byte[] a) Creates a new immutable list using a given array.ByteImmutableList(byte[] a, int offset, int length) Creates a new immutable list and fills it with the elements of a given array.Creates a new immutable list and fills it with a given type-specific collection.Creates a new immutable list and fills it with the elements returned by a type-specific iterator..Creates a new immutable list and fills it with a given type-specific list.ByteImmutableList(Collection<? extends Byte> c) Creates a new immutable list and fills it with a given collection. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanadd(byte k) Deprecated.final voidadd(int index, byte k) Deprecated.final voidDeprecated.final booleanDeprecated.final booleanaddAll(int index, ByteCollection c) Deprecated.final booleanDeprecated.final booleanaddAll(int index, Collection<? extends Byte> c) Deprecated.final booleanDeprecated.final booleanDeprecated.final booleanaddAll(Collection<? extends Byte> c) Deprecated.final voidaddElements(int index, byte[] a, int offset, int length) Deprecated.final voidclear()Deprecated.clone()intCompares this immutable list to another immutable list.intCompares this list to another object.booleanCompares this type-specific immutable list to another one.booleanvoidforEach(ByteConsumer action) Performs the given action for each element of this type-specificIterableuntil all elements have been processed or the action throws an exception.bytegetByte(int index) Returns the element at the specified position in this list.voidgetElements(int from, byte[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.intindexOf(byte k) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.booleanisEmpty()Checks whether the stack is empty.intlastIndexOf(byte k) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.listIterator(int index) Returns a type-specific list iterator on the list starting at a given index.static ByteImmutableListof()Returns an empty immutable list.static ByteImmutableListof(byte... init) Creates an immutable list using a list of elements.final booleanrem(byte k) Deprecated.final Byteremove(int index) Deprecated.final booleanDeprecated.final booleanDeprecated.final booleanremoveAll(Collection<?> c) Deprecated.final byteremoveByte(int index) Deprecated.final voidremoveElements(int from, int to) Deprecated.final booleanDeprecated.final booleanDeprecated.final voidreplaceAll(IntUnaryOperator operator) Deprecated.final voidreplaceAll(UnaryOperator<Byte> operator) Deprecated.final booleanDeprecated.final booleanretainAll(Collection<?> c) Deprecated.final byteset(int index, byte k) Deprecated.final ByteDeprecated.final voidsetElements(int index, byte[] a, int offset, int length) Deprecated.intsize()final voidsize(int size) Deprecated.final voidsort(ByteComparator comp) Deprecated.final voidsort(Comparator<? super Byte> comparator) Deprecated.Returns a type-specific spliterator on the elements of this collection.subList(int from, int to) Returns a type-specific view of the portion of this list from the indexfrom, inclusive, to the indexto, exclusive.byte[]toArray(byte[] 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.byte[]Returns a primitive type array containing the items of this collection.final voidunstableSort(ByteComparator comp) Deprecated.final voidunstableSort(Comparator<? super Byte> comparator) Deprecated.Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteList
addElements, contains, hashCode, iterator, listIterator, peekByte, popByte, push, topByte, toStringMethods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteCollection
contains, containsAll, containsAll, toByteArrayMethods inherited from class java.util.AbstractCollection
toArray, toArrayMethods inherited from interface it.unimi.dsi.fastutil.bytes.ByteCollection
addAll, contains, containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, rem, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toByteArrayMethods inherited from interface it.unimi.dsi.fastutil.bytes.ByteIterable
forEach, forEachMethods inherited from interface it.unimi.dsi.fastutil.bytes.ByteList
add, add, add, add, addAll, addAll, addAll, addElements, addElements, contains, get, indexOf, iterator, lastIndexOf, listIterator, remove, remove, removeByte, removeElements, replaceAll, replaceAll, replaceAll, set, set, setElements, setElements, setElements, size, sort, sort, unstableSort, unstableSortMethods inherited from interface java.util.Collection
toArray
-
Constructor Details
-
ByteImmutableList
public ByteImmutableList(byte[] a) Creates a new immutable list using a given array.Note that this constructor does not perform a defensive copy.
- Parameters:
a- the array that will be used to back this immutable list.
-
ByteImmutableList
Creates a new immutable list and fills it with a given collection.- Parameters:
c- a collection that will be used to fill the immutable list.
-
ByteImmutableList
Creates a new immutable list and fills it with a given type-specific collection.- Parameters:
c- a type-specific collection that will be used to fill the immutable list.
-
ByteImmutableList
Creates a new immutable list and fills it with a given type-specific list.- Parameters:
l- a type-specific list that will be used to fill the immutable list.
-
ByteImmutableList
public ByteImmutableList(byte[] a, int offset, int length) Creates a new immutable list and fills it with the elements of a given array.- Parameters:
a- an array whose elements will be used to fill the immutable list.offset- the first element to use.length- the number of elements to use.
-
ByteImmutableList
Creates a new immutable list and fills it with the elements returned by a type-specific iterator..- Parameters:
i- a type-specific iterator whose returned elements will fill the immutable list.
-
-
Method Details
-
of
Returns an empty immutable list.- Returns:
- an immutable list (possibly shared) that is empty.
-
of
Creates an immutable list using a list of elements.Note that this method does not perform a defensive copy.
- Parameters:
init- a list of elements that will be used to initialize the list.- Returns:
- a new immutable list containing the given elements.
-
getByte
-
indexOf
public int indexOf(byte k) Description copied from interface:ByteListReturns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.- Specified by:
indexOfin interfaceByteList- Overrides:
indexOfin classAbstractByteList- See Also:
-
lastIndexOf
public int lastIndexOf(byte k) Description copied from interface:ByteListReturns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.- Specified by:
lastIndexOfin interfaceByteList- Overrides:
lastIndexOfin classAbstractByteList- See Also:
-
size
public int size()- Specified by:
sizein interfaceCollection<Byte>- Specified by:
sizein interfaceList<Byte>- Specified by:
sizein classAbstractCollection<Byte>
-
isEmpty
public boolean isEmpty()Description copied from interface:StackChecks whether the stack is empty. -
getElements
public void getElements(int from, byte[] a, int offset, int length) Copies element of this type-specific list into the given array using optimized system calls.- Specified by:
getElementsin interfaceByteList- Overrides:
getElementsin classAbstractByteList- Parameters:
from- the start index (inclusive).a- the destination array.offset- the offset into the destination array where to store the first element copied.length- the number of elements to be copied.
-
forEach
Description copied from class:AbstractByteListPerforms the given action for each element of this type-specificIterableuntil all elements have been processed or the action throws an exception.- Specified by:
forEachin interfaceByteIterable- Overrides:
forEachin classAbstractByteList- Parameters:
action- the action to be performed for each element.- See Also:
-
toByteArray
public byte[] toByteArray()Description copied from interface:ByteCollectionReturns a primitive type array containing the items of this collection.- Specified by:
toByteArrayin interfaceByteCollection- Overrides:
toByteArrayin classAbstractByteList- Returns:
- a primitive type array containing the items of this collection.
- See Also:
-
toArray
public byte[] toArray(byte[] a) Description copied from interface:ByteCollectionReturns 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
Collection.toArray(Object[]), this methods just writes all elements of this collection: no special value will be added after the last one.- Specified by:
toArrayin interfaceByteCollection- Overrides:
toArrayin classAbstractByteList- Parameters:
a- if this array is big enough, it will be used to store this collection.- Returns:
- a primitive type array containing the items of this collection.
- See Also:
-
listIterator
Description copied from class:AbstractByteListReturns a type-specific list iterator on the list starting at a given index.- Specified by:
listIteratorin interfaceByteList- Specified by:
listIteratorin interfaceList<Byte>- Overrides:
listIteratorin classAbstractByteList- See Also:
-
spliterator
Description copied from interface:ByteCollectionReturns a type-specific spliterator on the elements of this collection.See
Collection.spliterator()for more documentation on the requirements of the returned spliterator.- Specified by:
spliteratorin interfaceByteCollection- Specified by:
spliteratorin interfaceByteIterable- Specified by:
spliteratorin interfaceByteList- Specified by:
spliteratorin interfaceCollection<Byte>- Specified by:
spliteratorin interfaceIterable<Byte>- Specified by:
spliteratorin interfaceList<Byte>- Returns:
- a type-specific spliterator on the elements of this collection.
-
subList
Returns a type-specific view of the portion of this list from the indexfrom, inclusive, to the indexto, exclusive.- Specified by:
subListin interfaceByteList- Specified by:
subListin interfaceList<Byte>- Overrides:
subListin classAbstractByteList- See Also:
- API Notes:
- The returned list will be immutable, but is currently not declared to return an instance
of
ImmutableListdue to complications of implementation details. This may change in a future version (in other words, do not consider the return type of this method to be stable if making a subclass ofImmutableList).
-
clone
-
equals
Compares this type-specific immutable list to another one.- Parameters:
l- a type-specific immutable list.- Returns:
- true if the argument contains the same elements of this type-specific immutable list.
- API Notes:
- This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
-
equals
- Specified by:
equalsin interfaceCollection<Byte>- Specified by:
equalsin interfaceList<Byte>- Overrides:
equalsin classAbstractByteList
-
compareTo
Compares this immutable list to another immutable list.- Parameters:
l- an immutable list.- Returns:
- a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.
- API Notes:
- This method exists only for sake of efficiency. The implementation inherited from the abstract implementation would already work.
-
compareTo
Description copied from class:AbstractByteListCompares this list to another object. If the argument is aList, this method performs a lexicographical comparison; otherwise, it throws aClassCastException.- Specified by:
compareToin interfaceComparable<List<? extends Byte>>- Overrides:
compareToin classAbstractByteList- Parameters:
l- a list.- Returns:
- if the argument is a
List, a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.
-
add
Deprecated.Description copied from class:AbstractByteListInserts the specified element at the specified position in this list (optional operation).- Specified by:
addin interfaceByteList- Overrides:
addin classAbstractByteList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
add
Deprecated.Description copied from class:AbstractByteListEnsures that this collection contains the specified element (optional operation).- Specified by:
addin interfaceByteCollection- Specified by:
addin interfaceByteList- Overrides:
addin classAbstractByteList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from class:AbstractByteList- Specified by:
addAllin interfaceCollection<Byte>- Specified by:
addAllin interfaceList<Byte>- Overrides:
addAllin classAbstractByteList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from class:AbstractByteListAdds all of the elements in the specified collection to this list (optional operation).- Specified by:
addAllin interfaceList<Byte>- Overrides:
addAllin classAbstractByteList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeByte
Deprecated.Description copied from class:AbstractByteListRemoves the element at the specified position in this list (optional operation).- Specified by:
removeBytein interfaceByteList- Overrides:
removeBytein classAbstractByteList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
rem
Deprecated.Description copied from class:AbstractByteListRemoves a single instance of the specified element from this collection, if it is present (optional operation).- Specified by:
remin interfaceByteCollection- Overrides:
remin classAbstractByteList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeAll
Deprecated.Description copied from class:AbstractByteCollection- Specified by:
removeAllin interfaceCollection<Byte>- Specified by:
removeAllin interfaceList<Byte>- Overrides:
removeAllin classAbstractByteCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
retainAll
Deprecated.Description copied from class:AbstractByteCollection- Specified by:
retainAllin interfaceCollection<Byte>- Specified by:
retainAllin interfaceList<Byte>- Overrides:
retainAllin classAbstractByteCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeIf
Deprecated.Description copied from interface:ByteCollection- Specified by:
removeIfin interfaceByteCollection- Specified by:
removeIfin interfaceCollection<Byte>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeIf
Deprecated.Description copied from interface:ByteCollectionRemove from this collection all elements which satisfy the given predicate.- Specified by:
removeIfin interfaceByteCollection- Parameters:
c- a predicate which returnstruefor elements to be removed.- Returns:
trueif any elements were removed.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
replaceAll
Deprecated.Description copied from interface:ByteList- Specified by:
replaceAllin interfaceByteList- Specified by:
replaceAllin interfaceList<Byte>- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
replaceAll
Deprecated.Description copied from interface:ByteListReplaces each element of this list with the result of applying the operator to that element, performing widening and narrowing primitive casts, until all elements have been processed or the action throws an exception.- Specified by:
replaceAllin interfaceByteList- Parameters:
operator- the operator to apply to each element- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
add
Deprecated.Description copied from interface:ByteList -
add
Deprecated.Description copied from class:AbstractByteCollection- Specified by:
addin interfaceByteCollection- Specified by:
addin interfaceByteList- Specified by:
addin interfaceCollection<Byte>- Specified by:
addin interfaceList<Byte>- Overrides:
addin classAbstractByteCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
remove
Deprecated.Description copied from interface:ByteList -
remove
Deprecated.Description copied from class:AbstractByteCollection- Specified by:
removein interfaceByteCollection- Specified by:
removein interfaceByteList- Specified by:
removein interfaceCollection<Byte>- Specified by:
removein interfaceList<Byte>- Overrides:
removein classAbstractByteCollection- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
set
Deprecated.Description copied from interface:ByteList -
addAll
Deprecated.Description copied from class:AbstractByteListAdds all elements of the given type-specific collection to this collection.- Specified by:
addAllin interfaceByteCollection- Overrides:
addAllin classAbstractByteList- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from interface:ByteListAppends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).- Specified by:
addAllin interfaceByteList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from interface:ByteListInserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).- Specified by:
addAllin interfaceByteList- Overrides:
addAllin classAbstractByteList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addAll
Deprecated.Description copied from interface:ByteListInserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).- Specified by:
addAllin interfaceByteList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeAll
Deprecated.Description copied from interface:ByteCollectionRemove from this collection all elements in the given type-specific collection.- Specified by:
removeAllin interfaceByteCollection- Overrides:
removeAllin classAbstractByteCollection- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
retainAll
Deprecated.Description copied from interface:ByteCollectionRetains in this collection only elements from the given type-specific collection.- Specified by:
retainAllin interfaceByteCollection- Overrides:
retainAllin classAbstractByteCollection- Parameters:
c- a type-specific collection.- Returns:
trueif this collection changed as a result of the call.- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
set
Deprecated.Description copied from class:AbstractByteListReplaces the element at the specified position in this list with the specified element (optional operation).- Specified by:
setin interfaceByteList- Overrides:
setin classAbstractByteList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
clear
Deprecated.Description copied from class:AbstractByteList- Specified by:
clearin interfaceCollection<Byte>- Specified by:
clearin interfaceList<Byte>- Overrides:
clearin classAbstractByteList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
size
Deprecated.Description copied from interface:ByteListSets the size of this list.If the specified size is smaller than the current size, the last elements are discarded. Otherwise, they are filled with 0/
null/false.- Specified by:
sizein interfaceByteList- Overrides:
sizein classAbstractByteList- Parameters:
size- the new size.- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
removeElements
Deprecated.Description copied from class:AbstractByteListRemoves (hopefully quickly) elements of this type-specific list.This is a trivial iterator-based based implementation. It is expected that implementations will override this method with a more optimized version.
- Specified by:
removeElementsin interfaceByteList- Overrides:
removeElementsin classAbstractByteList- Parameters:
from- the start index (inclusive).to- the end index (exclusive).- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
addElements
Deprecated.Description copied from class:AbstractByteListAdd (hopefully quickly) elements to this type-specific list.This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.
- Specified by:
addElementsin interfaceByteList- Overrides:
addElementsin classAbstractByteList- Parameters:
index- the index at which to add elements.a- the array containing the elements.offset- the offset of the first element to add.length- the number of elements to add.- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
setElements
Deprecated.Description copied from interface:ByteListSet (hopefully quickly) elements to match the array given. Sets each in this list to the corresponding elements in the array, as if byListIterator iter = listIterator(index); int i = 0; while (i < length) { iter.next(); iter.set(a[offset + i++]); }However, the exact implementation may be more efficient, taking into account whether random access is faster or not, or at the discretion of subclasses, abuse internals.- Specified by:
setElementsin interfaceByteList- Overrides:
setElementsin classAbstractByteList- Parameters:
index- the index at which to start setting elements.a- the array containing the elementsoffset- the offset of the first element to add.length- the number of elements to add.- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
sort
Deprecated.Description copied from interface:ByteListSort a list using a type-specific comparator.Pass
nullto sort using natural ordering.- Specified by:
sortin interfaceByteList- See Also:
- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
unstableSort
Deprecated.Description copied from interface:ByteListSorts this list using a sort not assured to be stable.Pass
nullto sort using natural ordering.This differs from
List.sort(java.util.Comparator)in that the results are not assured to be stable, but may be a bit faster.Unless a subclass specifies otherwise, the results of the method if the list is concurrently modified during the sort are unspecified.
- Specified by:
unstableSortin interfaceByteList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-
sort
Deprecated.Description copied from interface:ByteList -
unstableSort
Deprecated.Description copied from interface:ByteListSorts this list using a sort not assured to be stable.- Specified by:
unstableSortin interfaceByteList- Implementation Specification:
- Always throws
UnsupportedOperationExceptionas this is an immutable type.
-