org.joda.primitives.list
Interface FloatList

All Superinterfaces:
Collection<Float>, FloatCollection, FloatIterable, Iterable<Float>, List<Float>, PrimitiveCollectable<Float>, PrimitiveCollection<Float>, PrimitiveList<Float>
All Known Implementing Classes:
AbstractFloatList, ArrayFloatList, ImmutableArrayFloatList

public interface FloatList
extends PrimitiveList<Float>, FloatCollection

Defines a list of primitive float values.

This interface extends List allowing seamless integration with other APIs. All List methods can be used, using the primitive wrapper class Float. However, it will be much more efficient to use the methods defined here.

Since:
1.0
Version:
CODE GENERATED
Author:
Stephen Colebourne, Jason Tiscione

Method Summary
 boolean add(int index, float value)
          Adds a primitive value to this list at an index (optional operation).
 boolean addAll(int index, float[] values)
          Adds an array of primitive values to this list at an index (optional operation).
 float firstFloat()
          Gets the first primitive value.
 float getFloat(int index)
          Gets the primitive value at the specified index.
 int indexOf(float value)
          Gets the first index of the specified primitive value.
 int indexOf(float value, int fromIndexInclusive)
          Gets the first index of the specified primitive value from an index.
 FloatIterator iterator()
          Gets an iterator over this list capable of accessing the primitive values.
 float lastFloat()
          Gets the last primitive value.
 int lastIndexOf(float value)
          Gets the last index of the specified primitive value.
 int lastIndexOf(float value, int fromIndexInclusive)
          Gets the first index of the specified primitive value from an index.
 FloatListIterator listIterator()
          Gets a list iterator over this list capable of accessing the primitive values.
 FloatListIterator listIterator(int index)
          Gets a list iterator over this list from a start index capable of accessing the primitive values.
 Float remove(int index)
          Deprecated. use float removeFloatAt(int)
 float removeFloatAt(int index)
          Removes a primitive value by index from the list (optional operation).
 float set(int index, float value)
          Sets the primitive value at a specified index (optional operation).
 FloatList subList(int fromIndexInclusive, int toIndexExclusive)
          Gets a range view of part of this list.
 float[] toFloatArray(int fromIndexInclusive, int toIndexExclusive)
          Gets a range of elements as an array.
 
Methods inherited from interface org.joda.primitives.list.PrimitiveList
first, last, removeRange
 
Methods inherited from interface org.joda.primitives.collection.PrimitiveCollection
containsAny
 
Methods inherited from interface org.joda.primitives.PrimitiveCollectable
clear, clone, isEmpty, isModifiable, optimize, size
 
Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, lastIndexOf, remove, removeAll, retainAll, set, size, toArray, toArray
 
Methods inherited from interface org.joda.primitives.collection.FloatCollection
add, addAll, addAll, contains, containsAll, containsAll, containsAny, containsAny, removeAll, removeAll, removeAll, removeFirst, retainAll, retainAll, toFloatArray, toFloatArray
 
Methods inherited from interface org.joda.primitives.collection.PrimitiveCollection
containsAny
 
Methods inherited from interface org.joda.primitives.PrimitiveCollectable
clear, clone, isEmpty, isModifiable, optimize, size
 

Method Detail

iterator

FloatIterator iterator()
Gets an iterator over this list capable of accessing the primitive values.

Specified by:
iterator in interface Collection<Float>
Specified by:
iterator in interface FloatCollection
Specified by:
iterator in interface FloatIterable
Specified by:
iterator in interface Iterable<Float>
Specified by:
iterator in interface List<Float>
Returns:
an iterator over this list, not null

getFloat

float getFloat(int index)
Gets the primitive value at the specified index.

Parameters:
index - the index to get from
Returns:
value at the index
Throws:
IndexOutOfBoundsException - if the index is invalid

firstFloat

float firstFloat()
Gets the first primitive value.

Returns:
value at index zero
Throws:
IndexOutOfBoundsException - if the size is zero

lastFloat

float lastFloat()
Gets the last primitive value.

Returns:
value at index size() - 1
Throws:
IndexOutOfBoundsException - if the size is zero

listIterator

FloatListIterator listIterator()
Gets a list iterator over this list capable of accessing the primitive values.

Specified by:
listIterator in interface List<Float>
Returns:
an iterator over this list, not null

listIterator

FloatListIterator listIterator(int index)
Gets a list iterator over this list from a start index capable of accessing the primitive values.

Specified by:
listIterator in interface List<Float>
Parameters:
index - the index to start from
Returns:
an iterator over this list, not null
Throws:
IndexOutOfBoundsException - if the index is invalid

indexOf

int indexOf(float value)
Gets the first index of the specified primitive value.

Parameters:
value - the value to search for
Returns:
the zero-based index, or -1 if not found

indexOf

int indexOf(float value,
            int fromIndexInclusive)
Gets the first index of the specified primitive value from an index.

This method follows the conventions of String in that a negative index is treated as zero, and an index greater than the list size will simply return -1.

Parameters:
value - the value to search for
fromIndexInclusive - the index to start searching from, inclusive
Returns:
the zero-based index, or -1 if not found

lastIndexOf

int lastIndexOf(float value)
Gets the last index of the specified primitive value.

Parameters:
value - the value to search for
Returns:
the zero-based index, or -1 if not found

lastIndexOf

int lastIndexOf(float value,
                int fromIndexInclusive)
Gets the first index of the specified primitive value from an index.

This method follows the conventions of String in that an index greater than the list size will start searching at the list size, and a negative index simply returns -1.

Parameters:
value - the value to search for
fromIndexInclusive - the index to start searching from, inclusive
Returns:
the zero-based index, or -1 if not found

toFloatArray

float[] toFloatArray(int fromIndexInclusive,
                     int toIndexExclusive)
Gets a range of elements as an array.

Parameters:
fromIndexInclusive - the index to start from, inclusive
toIndexExclusive - the index to end at, exclusive
Returns:
a new array containing a copy of the range of elements, not null
Throws:
IndexOutOfBoundsException - if either index is invalid

subList

FloatList subList(int fromIndexInclusive,
                  int toIndexExclusive)
Gets a range view of part of this list.

This method allows operations to work on a range within the greater list. Changes made to the either object will affect the other.

Specified by:
subList in interface List<Float>
Parameters:
fromIndexInclusive - the index to start from, inclusive
toIndexExclusive - the index to end at, exclusive
Returns:
a new FloatList for the subList, not null
Throws:
IndexOutOfBoundsException - if either index is invalid

add

boolean add(int index,
            float value)
Adds a primitive value to this list at an index (optional operation).

This method is optional, throwing an UnsupportedOperationException if the collection cannot be added to.

Parameters:
index - the index to add at
value - the value to add to this collection
Returns:
true if this list was modified by this method call
Throws:
IndexOutOfBoundsException - if the index is invalid
IllegalArgumentException - if value is rejected by this collection
UnsupportedOperationException - if not supported by this collection

addAll

boolean addAll(int index,
               float[] values)
Adds an array of primitive values to this list at an index (optional operation).

This method is optional, throwing an UnsupportedOperationException if the collection cannot be added to.

Parameters:
index - the index to add at
values - the values to add to this collection, null treated as empty array
Returns:
true if this list was modified by this method call
Throws:
IndexOutOfBoundsException - if the index is invalid
IllegalArgumentException - if value is rejected by this collection
UnsupportedOperationException - if not supported by this collection

remove

@Deprecated
Float remove(int index)
Deprecated. use float removeFloatAt(int)

Removes a primitive value by index from the list (optional operation).

This method is optional, throwing an UnsupportedOperationException if the collection cannot be added to.

This method is deprecated to serve as a warning to developers. Using it can be confusing as it removes by index rather than by primitive. The method will still function correctly as the method is defined in the List interface. Use removeFloatAt(int) instead.

Specified by:
remove in interface List<Float>
Parameters:
index - the index to remove from
Returns:
the primitive value previously at this index
Throws:
IndexOutOfBoundsException - if the index is invalid
UnsupportedOperationException - if not supported by this collection

removeFloatAt

float removeFloatAt(int index)
Removes a primitive value by index from the list (optional operation).

This method is optional, throwing an UnsupportedOperationException if the collection cannot be added to.

Parameters:
index - the index to remove from
Returns:
the primitive value previously at this index
Throws:
IndexOutOfBoundsException - if the index is invalid
UnsupportedOperationException - if not supported by this collection

set

float set(int index,
          float value)
Sets the primitive value at a specified index (optional operation).

This method is optional, throwing an UnsupportedOperationException if the collection cannot be changed.

Parameters:
index - the index to set
value - the value to store
Returns:
the previous value at the index
Throws:
IndexOutOfBoundsException - if the index is invalid
IllegalArgumentException - if value is rejected by this collection
UnsupportedOperationException - if not supported by this collection


Copyright © 2005-2010 Joda.org. All Rights Reserved.