it.unimi.dsi.fastutil.bytes
Interface ByteList

All Superinterfaces:
ByteCollection, ByteIterable, Collection<Byte>, Comparable<List<? extends Byte>>, Iterable<Byte>, List<Byte>
All Known Implementing Classes:
AbstractByteList, AbstractByteList.ByteSubList, ByteArrayList, ByteLists.EmptyList, ByteLists.Singleton, ByteLists.SynchronizedList, ByteLists.UnmodifiableList

public interface ByteList
extends List<Byte>, Comparable<List<? extends Byte>>, ByteCollection

A type-specific List; provides some additional methods that use polymorphism to avoid (un)boxing.

Note that this type-specific interface extends Comparable: it is expected that implementing classes perform a lexicographical comparison using the standard operator "less then" for primitive types, and the usual compareTo() method for objects.

Additionally, this interface strengthens listIterator(), listIterator(int) and subList(int,int).

Besides polymorphic methods, this interfaces specifies methods to copy into an array or remove contiguous sublists. Although the abstract implementation of this interface provides simple, one-by-one implementations of these methods, it is expected that concrete implementation override them with optimized versions.

See Also:
List

Method Summary
 void add(int index, byte key)
           
 boolean addAll(ByteList c)
           
 boolean addAll(int index, ByteCollection c)
           
 boolean addAll(int index, ByteList c)
           
 void addElements(int index, byte[] a)
          Add (hopefully quickly) elements to this type-specific list.
 void addElements(int index, byte[] a, int offset, int length)
          Add (hopefully quickly) elements to this type-specific list.
 ByteListIterator byteListIterator()
          Deprecated. As of fastutil 5, replaced by listIterator().
 ByteListIterator byteListIterator(int index)
          Deprecated. As of fastutil 5, replaced by listIterator(int).
 ByteList byteSubList(int from, int to)
          Deprecated. As of fastutil 5, replaced by subList(int,int).
 byte getByte(int index)
           
 void getElements(int from, byte[] a, int offset, int length)
          Copies (hopefully quickly) elements of this type-specific list into the given array.
 int indexOf(byte k)
           
 ByteIterator iterator()
          Returns a type-specific iterator on the elements of this list (in proper sequence).
 int lastIndexOf(byte k)
           
 ByteListIterator listIterator()
          Returns a type-specific list iterator on the list.
 ByteListIterator listIterator(int index)
          Returns a type-specific list iterator on the list starting at a given index.
 byte removeByte(int index)
           
 void removeElements(int from, int to)
          Removes (hopefully quickly) elements of this type-specific list.
 byte set(int index, byte k)
           
 void size(int size)
          Sets the size of this list.
 ByteList subList(int from, int to)
          Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.
 
Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, lastIndexOf, remove, remove, removeAll, retainAll, set, size, toArray, toArray
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteCollection
add, addAll, byteIterator, contains, containsAll, rem, removeAll, retainAll, toArray, toArray, toByteArray, toByteArray
 

Method Detail

iterator

ByteIterator iterator()
Returns a type-specific iterator on the elements of this list (in proper sequence). Note that this specification strengthens the one given in List.iterator(). It would not be normally necessary, but Iterable.iterator() is bizarrily re-specified in List.

Specified by:
iterator in interface ByteCollection
Specified by:
iterator in interface ByteIterable
Specified by:
iterator in interface Collection<Byte>
Specified by:
iterator in interface Iterable<Byte>
Specified by:
iterator in interface List<Byte>
Returns:
an iterator on the elements of this list (in proper sequence).

byteListIterator

@Deprecated
ByteListIterator byteListIterator()
Deprecated. As of fastutil 5, replaced by listIterator().

Returns a type-specific list iterator on the list.

See Also:
listIterator()

byteListIterator

@Deprecated
ByteListIterator byteListIterator(int index)
Deprecated. As of fastutil 5, replaced by listIterator(int).

Returns a type-specific list iterator on the list starting at a given index.

See Also:
listIterator(int)

listIterator

ByteListIterator listIterator()
Returns a type-specific list iterator on the list.

Specified by:
listIterator in interface List<Byte>
See Also:
listIterator()

listIterator

ByteListIterator listIterator(int index)
Returns a type-specific list iterator on the list starting at a given index.

Specified by:
listIterator in interface List<Byte>
See Also:
listIterator(int)

byteSubList

@Deprecated
ByteList byteSubList(int from,
                                int to)
Deprecated. As of fastutil 5, replaced by subList(int,int).

Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.

See Also:
List.subList(int,int)

subList

ByteList subList(int from,
                 int to)
Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.

Note that this specification strengthens the one given in List.subList(int,int).

Specified by:
subList in interface List<Byte>
See Also:
List.subList(int,int)

size

void size(int size)
Sets 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.

Parameters:
size - the new size.

getElements

void getElements(int from,
                 byte[] a,
                 int offset,
                 int length)
Copies (hopefully quickly) elements of this type-specific list into the given array.

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.

removeElements

void removeElements(int from,
                    int to)
Removes (hopefully quickly) elements of this type-specific list.

Parameters:
from - the start index (inclusive).
to - the end index (exclusive).

addElements

void addElements(int index,
                 byte[] a)
Add (hopefully quickly) elements to this type-specific list.

Parameters:
index - the index at which to add elements.
a - the array containing the elements.

addElements

void addElements(int index,
                 byte[] a,
                 int offset,
                 int length)
Add (hopefully quickly) elements to this type-specific list.

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.

add

void add(int index,
         byte key)
See Also:
List.add(int,Object)

addAll

boolean addAll(int index,
               ByteCollection c)
See Also:
List.add(int,Object)

addAll

boolean addAll(int index,
               ByteList c)
See Also:
List.add(int,Object)

addAll

boolean addAll(ByteList c)
See Also:
List.add(int,Object)

getByte

byte getByte(int index)
See Also:
List.get(int)

indexOf

int indexOf(byte k)
See Also:
List.indexOf(Object)

lastIndexOf

int lastIndexOf(byte k)
See Also:
List.lastIndexOf(Object)

removeByte

byte removeByte(int index)
See Also:
List.remove(int)

set

byte set(int index,
         byte k)
See Also:
List.set(int,Object)