org.apache.commons.collections.primitives.decorators
Class UnmodifiableFloatList

java.lang.Object
  extended byorg.apache.commons.collections.primitives.decorators.BaseProxyFloatCollection
      extended byorg.apache.commons.collections.primitives.decorators.BaseProxyFloatList
          extended byorg.apache.commons.collections.primitives.decorators.BaseUnmodifiableFloatList
              extended byorg.apache.commons.collections.primitives.decorators.UnmodifiableFloatList
All Implemented Interfaces:
FloatCollection, FloatList, Serializable

public final class UnmodifiableFloatList
extends BaseUnmodifiableFloatList
implements Serializable

Since:
Commons Primitives 1.0
Version:
$Revision: 1.1 $ $Date: 2003/10/29 20:07:54 $
Author:
Rodney Waldhoff
See Also:
Serialized Form

Field Summary
private  FloatList proxied
           
 
Constructor Summary
(package private) UnmodifiableFloatList(FloatList list)
           
 
Method Summary
 boolean add(float element)
          Appends the specified element to the end of me (optional operation).
 void add(int index, float element)
          Inserts the specified element at the specified position (optional operation).
 boolean addAll(FloatCollection c)
          Adds all of the elements in the specified collection to me (optional operation).
 boolean addAll(int index, FloatCollection collection)
          Inserts all of the elements in the specified collection into me, at the specified position (optional operation).
 void clear()
          Removes all my elements (optional operation).
 boolean contains(float element)
          Returns true iff I contain the specified element.
 boolean containsAll(FloatCollection c)
          Returns true iff I contain all of the elements in the given collection.
 boolean equals(Object obj)
          Returns true iff that is an FloatList that contains the same elements in the same order as me.
 float get(int index)
          Returns the value of the element at the specified position within me.
protected  FloatCollection getProxiedCollection()
           
protected  FloatList getProxiedList()
           
 int hashCode()
          Returns my hash code.
 int indexOf(float element)
          Returns the index of the first occurrence of the specified element within me, or -1 if I do not contain the element.
 boolean isEmpty()
          Returns true iff I contain no elements.
 FloatIterator iterator()
          Returns an iterator over all my elements, in the appropriate sequence.
 int lastIndexOf(float element)
          Returns the index of the last occurrence of the specified element within me, or -1 if I do not contain the element.
 FloatListIterator listIterator()
          Returns a bidirectional iterator over all my elements, in the appropriate sequence.
 FloatListIterator listIterator(int index)
          Returns a bidirectional iterator over all my elements, in the appropriate sequence, starting at the specified position.
 boolean removeAll(FloatCollection c)
          Removes all of my elements that are contained in the specified collection (optional operation).
 boolean removeElement(float element)
          Removes a single occurrence of the specified element (optional operation).
 float removeElementAt(int index)
          Removes the element at the specified position in (optional operation).
 boolean retainAll(FloatCollection c)
          Removes all of my elements that are not contained in the specified collection (optional operation).
 float set(int index, float element)
          Replaces the element at the specified position in me with the specified element (optional operation).
 int size()
          Returns the number of elements I contain.
 FloatList subList(int fromIndex, int toIndex)
          Returns a view of the elements within me between the specified fromIndex, inclusive, and toIndex, exclusive.
 float[] toArray()
          Returns an array containing all of my elements.
 float[] toArray(float[] a)
          Returns an array containing all of my elements, using the given array if it is large enough.
 String toString()
           
static FloatList wrap(FloatList list)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.commons.collections.primitives.FloatList
equals, hashCode
 
Methods inherited from interface org.apache.commons.collections.primitives.FloatCollection
contains, containsAll, isEmpty, size, toArray, toArray
 

Field Detail

proxied

private FloatList proxied
Constructor Detail

UnmodifiableFloatList

UnmodifiableFloatList(FloatList list)
Method Detail

wrap

public static final FloatList wrap(FloatList list)

getProxiedList

protected FloatList getProxiedList()
Specified by:
getProxiedList in class BaseProxyFloatList

add

public final void add(int index,
                      float element)
Description copied from interface: FloatList
Inserts the specified element at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right, increasing their indices.

Specified by:
add in interface FloatList
Overrides:
add in class BaseProxyFloatList

addAll

public final boolean addAll(int index,
                            FloatCollection collection)
Description copied from interface: FloatList
Inserts all of the elements in the specified collection into me, at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right, increasing their indices. The new elements will appear in the order that they are returned by the given collection's iterator.

Specified by:
addAll in interface FloatList
Overrides:
addAll in class BaseProxyFloatList

removeElementAt

public final float removeElementAt(int index)
Description copied from interface: FloatList
Removes the element at the specified position in (optional operation). Any subsequent elements are shifted to the left, subtracting one from their indices. Returns the element that was removed.

Specified by:
removeElementAt in interface FloatList
Overrides:
removeElementAt in class BaseProxyFloatList

set

public final float set(int index,
                       float element)
Description copied from interface: FloatList
Replaces the element at the specified position in me with the specified element (optional operation).

Specified by:
set in interface FloatList
Overrides:
set in class BaseProxyFloatList

add

public final boolean add(float element)
Description copied from interface: FloatList
Appends the specified element to the end of me (optional operation). Returns true iff I changed as a result of this call.

If a collection refuses to add the specified element for any reason other than that it already contains the element, it must throw an exception (rather than simply returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

Specified by:
add in interface FloatList
Overrides:
add in class BaseProxyFloatCollection

addAll

public final boolean addAll(FloatCollection c)
Description copied from interface: FloatCollection
Adds all of the elements in the specified collection to me (optional operation).

Specified by:
addAll in interface FloatCollection
Overrides:
addAll in class BaseProxyFloatCollection

clear

public final void clear()
Description copied from interface: FloatCollection
Removes all my elements (optional operation). I will be empty after this method successfully returns.

Specified by:
clear in interface FloatCollection
Overrides:
clear in class BaseProxyFloatCollection

removeAll

public final boolean removeAll(FloatCollection c)
Description copied from interface: FloatCollection
Removes all of my elements that are contained in the specified collection (optional operation). The behavior of this method is unspecified if the given collection is modified while this method is executing. Note that this includes the case in which the given collection is this collection, and it is not empty.

Specified by:
removeAll in interface FloatCollection
Overrides:
removeAll in class BaseProxyFloatCollection

removeElement

public final boolean removeElement(float element)
Description copied from interface: FloatCollection
Removes a single occurrence of the specified element (optional operation).

Specified by:
removeElement in interface FloatCollection
Overrides:
removeElement in class BaseProxyFloatCollection

retainAll

public final boolean retainAll(FloatCollection c)
Description copied from interface: FloatCollection
Removes all of my elements that are not contained in the specified collection (optional operation). (In other words, retains only my elements that are contained in the specified collection.) The behavior of this method is unspecified if the given collection is modified while this method is executing.

Specified by:
retainAll in interface FloatCollection
Overrides:
retainAll in class BaseProxyFloatCollection

subList

public final FloatList subList(int fromIndex,
                               int toIndex)
Description copied from interface: FloatList
Returns a view of the elements within me between the specified fromIndex, inclusive, and toIndex, exclusive. The returned FloatList is backed by me, so that any changes in the returned list are reflected in me, and vice-versa. The returned list supports all of the optional operations that I support.

Note that when fromIndex == toIndex, the returned list is initially empty, and when fromIndex == 0 && toIndex == size() the returned list is my "improper" sublist, containing all my elements.

The semantics of the returned list become undefined if I am structurally modified in any way other than via the returned list.

Specified by:
subList in interface FloatList
Overrides:
subList in class BaseProxyFloatList

iterator

public final FloatIterator iterator()
Description copied from interface: FloatList
Returns an iterator over all my elements, in the appropriate sequence.

Specified by:
iterator in interface FloatList
Overrides:
iterator in class BaseProxyFloatCollection

listIterator

public FloatListIterator listIterator()
Description copied from interface: FloatList
Returns a bidirectional iterator over all my elements, in the appropriate sequence.

Specified by:
listIterator in interface FloatList
Overrides:
listIterator in class BaseProxyFloatList

listIterator

public FloatListIterator listIterator(int index)
Description copied from interface: FloatList
Returns a bidirectional iterator over all my elements, in the appropriate sequence, starting at the specified position. The specified index indicates the first element that would be returned by an initial call to the next method. An initial call to the previous method would return the element with the specified index minus one.

Specified by:
listIterator in interface FloatList
Overrides:
listIterator in class BaseProxyFloatList

getProxiedCollection

protected final FloatCollection getProxiedCollection()
Specified by:
getProxiedCollection in class BaseProxyFloatCollection

get

public float get(int index)
Description copied from interface: FloatList
Returns the value of the element at the specified position within me.

Specified by:
get in interface FloatList
Parameters:
index - the index of the element to return
Returns:
the value of the element at the specified position

indexOf

public int indexOf(float element)
Description copied from interface: FloatList
Returns the index of the first occurrence of the specified element within me, or -1 if I do not contain the element.

Specified by:
indexOf in interface FloatList
Parameters:
element - the element to search for
Returns:
the smallest index of an element matching the specified value, or -1 if no such matching element can be found

lastIndexOf

public int lastIndexOf(float element)
Description copied from interface: FloatList
Returns the index of the last occurrence of the specified element within me, or -1 if I do not contain the element.

Specified by:
lastIndexOf in interface FloatList
Parameters:
element - the element to search for
Returns:
the largest index of an element matching the specified value, or -1 if no such matching element can be found

contains

public boolean contains(float element)
Description copied from interface: FloatCollection
Returns true iff I contain the specified element.

Specified by:
contains in interface FloatCollection
Parameters:
element - the value whose presence within me is to be tested
Returns:
true iff I contain the specified element

containsAll

public boolean containsAll(FloatCollection c)
Description copied from interface: FloatCollection
Returns true iff I contain all of the elements in the given collection.

Specified by:
containsAll in interface FloatCollection
Parameters:
c - the collection of elements whose presence within me is to be tested
Returns:
true iff I contain the all the specified elements

isEmpty

public boolean isEmpty()
Description copied from interface: FloatCollection
Returns true iff I contain no elements.

Specified by:
isEmpty in interface FloatCollection
Returns:
true iff I contain no elements.

size

public int size()
Description copied from interface: FloatCollection
Returns the number of elements I contain.

Specified by:
size in interface FloatCollection
Returns:
the number of elements I contain

toArray

public float[] toArray()
Description copied from interface: FloatCollection
Returns an array containing all of my elements. The length of the returned array will be equal to my size.

The returned array will be independent of me, so that callers may modify that returned array without modifying this collection.

When I guarantee the order in which elements are returned by an iterator, the returned array will contain elements in the same order.

Specified by:
toArray in interface FloatCollection
Returns:
an array containing all my elements

toArray

public float[] toArray(float[] a)
Description copied from interface: FloatCollection
Returns an array containing all of my elements, using the given array if it is large enough. When the length of the given array is larger than the number of elements I contain, values outside of my range will be unchanged.

The returned array will be independent of me, so that callers may modify that returned array without modifying this collection.

When I guarantee the order in which elements are returned by an iterator, the returned array will contain elements in the same order.

Specified by:
toArray in interface FloatCollection
Parameters:
a - an array that may be used to contain the elements
Returns:
an array containing all my elements

equals

public boolean equals(Object obj)

hashCode

public int hashCode()

toString

public String toString()


Copyright (c) 2002-2003 - Apache Software Foundation