elemental.util.
Interface ArrayOfInt
-
public interface ArrayOfInt
A lightweight array of integers.
See Also:
JsArrayOfInt
-
-
Method Summary
All Methods Modifier and Type Method and Description ArrayOfInt
concat(ArrayOfInt values)
Returns a new array that is the concatenation of this array and
values
.boolean
contains(int value)
Indicates whether the array contains the specified value.
int
get(int index)
Gets the value at a given index.
int
indexOf(int value)
Returns the index of the specified value or
-1
if the value is not found.void
insert(int index, int value)
Inserts a new element into the array at the specified index.
boolean
isEmpty()
Returns true if the length of the array is zero.
boolean
isSet(int index)
Check that the specified
index
has been initialized to a valid value.String
join()
Convert each element of the array to a String and join them with a comma separator.
String
join(String separator)
Convert each element of the array to a String and join them with a comma separator.
int
length()
Gets the length of the array.
int
peek()
Returns the last value of the array;
int
pop()
Remove and return the element from the end of the array.
void
push(int value)
Pushes the given integer onto the end of the array.
void
remove(int value)
Searches for the specified value in the array and removes the first occurrence if found.
void
removeByIndex(int index)
Removes the element at the specified index.
void
set(int index, int value)
Sets the value value at a given index.
void
setLength(int length)
Reset the length of the array.
int
shift()
Shifts the first value off the array.
void
sort()
Sorts the contents of the array in ascending order.
void
sort(CanCompareInt comparator)
Sorts the contents of the Array based on the
CanCompareInt
.ArrayOfInt
splice(int index, int count)
Removes the specified number of elements starting at index and returns the removed elements.
void
unshift(int value)
Shifts a value onto the beginning of the array.
-
-
-
Method Detail
-
concat
ArrayOfInt concat(ArrayOfInt values)
Returns a new array that is the concatenation of this array and
values
. This method does not mutate the current array.
-
contains
boolean contains(int value)
Indicates whether the array contains the specified value.
-
get
int get(int index)
Gets the value at a given index. If no value exists at the given index, a type-conversion error will occur in hosted mode and unpredictable behavior may occur in web mode. If the numeric value returned is non-integral, it will cause a warning in hosted mode, and may affect the results of mathematical expressions.
Parameters:
index
- the index to be retrievedReturns:
the value at the given index
-
indexOf
int indexOf(int value)
Returns the index of the specified value or
-1
if the value is not found.
-
insert
void insert(int index, int value)
Inserts a new element into the array at the specified index. Note: If index >= the length of the array, the element will be appended to the end. Also if the index is negative, the element will be inserted starting from the end of the array.
-
isEmpty
boolean isEmpty()
Returns true if the length of the array is zero.
Returns:
true when length is zero
-
isSet
boolean isSet(int index)
Check that the specified
index
has been initialized to a valid value.
-
join
String join()
Convert each element of the array to a String and join them with a comma separator. The value returned from this method may vary between browsers based on how JavaScript values are converted into strings.
-
join
String join(String separator)
Convert each element of the array to a String and join them with a comma separator. The value returned from this method may vary between browsers based on how JavaScript values are converted into strings.
-
length
int length()
Gets the length of the array.
Returns:
the array length
-
peek
int peek()
Returns the last value of the array;
Returns:
the last value
-
pop
int pop()
Remove and return the element from the end of the array.
Returns:
the removed value
-
push
void push(int value)
Pushes the given integer onto the end of the array.
-
remove
void remove(int value)
Searches for the specified value in the array and removes the first occurrence if found.
-
removeByIndex
void removeByIndex(int index)
Removes the element at the specified index.
-
set
void set(int index, int value)
Sets the value value at a given index. If the index is out of bounds, the value will still be set. The array's length will be updated to encompass the bounds implied by the added value.
Parameters:
index
- the index to be setvalue
- the value to be stored
-
setLength
void setLength(int length)
Reset the length of the array.
Parameters:
length
- the new length of the array
-
shift
int shift()
Shifts the first value off the array.
Returns:
the shifted value
-
sort
void sort()
Sorts the contents of the array in ascending order.
-
sort
void sort(CanCompareInt comparator)
Sorts the contents of the Array based on the
CanCompareInt
.Parameters:
comparator
-
-
splice
ArrayOfInt splice(int index, int count)
Removes the specified number of elements starting at index and returns the removed elements.
-
unshift
void unshift(int value)
Shifts a value onto the beginning of the array.
Parameters:
value
- the value to the stored
-
-