it.unimi.dsi.fastutil.bytes.ByteList Maven / Gradle / Ivy
Show all versions of fastutil Show documentation
/*
* Copyright (C) 2002-2017 Sebastiano Vigna
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package it.unimi.dsi.fastutil.bytes;
import java.util.List;
/**
* A type-specific {@link List}; provides some additional methods that use
* polymorphism to avoid (un)boxing.
*
*
* Note that this type-specific interface extends {@link Comparable}: it is
* expected that implementing classes perform a lexicographical comparison using
* the standard operator "less then" for primitive types, and the usual
* {@link Comparable#compareTo(Object) compareTo()} method for objects.
*
*
* Additionally, this interface strengthens {@link #listIterator()},
* {@link #listIterator(int)} and {@link #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 List
*/
public interface ByteList extends List, Comparable>, ByteCollection {
/**
* Returns a type-specific iterator on the elements of this list.
*
*
* Note that this specification strengthens the one given in
* {@link List#iterator()}. It would not be normally necessary, but
* {@link java.lang.Iterable#iterator()} is bizarrily re-specified in
* {@link List}.
*
* @return an iterator on the elements of this list.
*/
@Override
ByteListIterator iterator();
/**
* Returns a type-specific list iterator on the list.
*
* @see List#listIterator()
*/
@Override
ByteListIterator listIterator();
/**
* Returns a type-specific list iterator on the list starting at a given index.
*
* @see List#listIterator(int)
*/
@Override
ByteListIterator listIterator(int index);
/**
* Returns a type-specific view of the portion of this list from the index
* {@code from}, inclusive, to the index {@code to}, exclusive.
*
*
* Note that this specification strengthens the one given in
* {@link List#subList(int,int)}.
*
* @see List#subList(int,int)
*/
@Override
ByteList subList(int from, int to);
/**
* 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/{@code null}/{@code false}.
*
* @param size
* the new size.
*/
void size(int size);
/**
* Copies (hopefully quickly) elements of this type-specific list into the given
* array.
*
* @param from
* the start index (inclusive).
* @param a
* the destination array.
* @param offset
* the offset into the destination array where to store the first
* element copied.
* @param length
* the number of elements to be copied.
*/
void getElements(int from, byte a[], int offset, int length);
/**
* Removes (hopefully quickly) elements of this type-specific list.
*
* @param from
* the start index (inclusive).
* @param to
* the end index (exclusive).
*/
void removeElements(int from, int to);
/**
* Add (hopefully quickly) elements to this type-specific list.
*
* @param index
* the index at which to add elements.
* @param a
* the array containing the elements.
*/
void addElements(int index, byte a[]);
/**
* Add (hopefully quickly) elements to this type-specific list.
*
* @param index
* the index at which to add elements.
* @param a
* the array containing the elements.
* @param offset
* the offset of the first element to add.
* @param length
* the number of elements to add.
*/
void addElements(int index, byte a[], int offset, int length);
/**
* Appends the specified element to the end of this list (optional operation).
*
* @see List#add(Object)
*/
@Override
boolean add(byte key);
/**
* Inserts the specified element at the specified position in this list
* (optional operation).
*
* @see List#add(int,Object)
*/
void add(int index, byte key);
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
default void add(int index, Byte key) {
add(index, (key).byteValue());
}
/**
* Inserts all of the elements in the specified type-specific collection into
* this type-specific list at the specified position (optional operation).
*
* @see List#addAll(int,java.util.Collection)
*/
boolean addAll(int index, ByteCollection c);
/**
* Inserts all of the elements in the specified type-specific list into this
* type-specific list at the specified position (optional operation).
*
* @see List#add(int,Object)
*/
boolean addAll(int index, ByteList c);
/**
* Appends all of the elements in the specified type-specific list to the end of
* this type-specific list (optional operation).
*
* @see List#add(int,Object)
*/
boolean addAll(ByteList c);
/**
* Replaces the element at the specified position in this list with the
* specified element (optional operation).
*
* @see List#set(int,Object)
*/
byte set(int index, byte k);
/**
* Returns the element at the specified position in this list.
*
* @see List#get(int)
*/
byte getByte(int index);
/**
* Returns the index of the first occurrence of the specified element in this
* list, or -1 if this list does not contain the element.
*
* @see List#indexOf(Object)
*/
int indexOf(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.
*
* @see List#lastIndexOf(Object)
*/
int lastIndexOf(byte k);
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
default boolean contains(final Object key) {
return ByteCollection.super.contains(key);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
default Byte get(int index) {
return Byte.valueOf(getByte(index));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
default int indexOf(Object o) {
return indexOf(((Byte) (o)).byteValue());
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
default int lastIndexOf(Object o) {
return lastIndexOf(((Byte) (o)).byteValue());
}
/**
* {@inheritDoc}
*
* This method specification is a workaround for
* bug
* 8177440.
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
default boolean add(Byte k) {
return add((k).byteValue());
}
/**
* Removes the element at the specified position in this list (optional
* operation).
*
* @see List#remove(int)
*/
byte removeByte(int index);
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
default boolean remove(final Object key) {
return ByteCollection.super.remove(key);
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
default Byte remove(int index) {
return Byte.valueOf(removeByte(index));
}
/**
* {@inheritDoc}
*
* @deprecated Please use the corresponding type-specific method instead.
*/
@Deprecated
@Override
default Byte set(int index, Byte k) {
return Byte.valueOf(set(index, (k).byteValue()));
}
}