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

java.lang.Object
  extended by org.apache.commons.collections.primitives.decorators.BaseProxyCharCollection
      extended by org.apache.commons.collections.primitives.decorators.BaseProxyCharList
          extended by org.apache.commons.collections.primitives.decorators.BaseUnmodifiableCharList
All Implemented Interfaces:
CharCollection, CharList
Direct Known Subclasses:
NonSerializableUnmodifiableCharList, UnmodifiableCharList

abstract class BaseUnmodifiableCharList
extends BaseProxyCharList

Since:
Commons Primitives 1.0
Version:
$Revision: 1.1 $ $Date: 2003/10/29 19:20:07 $
Author:
Rodney Waldhoff

Constructor Summary
BaseUnmodifiableCharList()
           
 
Method Summary
 boolean add(char element)
          Ensures that I contain the specified element (optional operation).
 void add(int index, char element)
          Inserts the specified element at the specified position (optional operation).
 boolean addAll(CharCollection c)
          Adds all of the elements in the specified collection to me (optional operation).
 boolean addAll(int index, CharCollection 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).
 CharIterator iterator()
          Returns an iterator over all my elements.
 CharListIterator listIterator()
          Returns a bidirectional iterator over all my elements, in the appropriate sequence.
 CharListIterator listIterator(int index)
          Returns a bidirectional iterator over all my elements, in the appropriate sequence, starting at the specified position.
 boolean removeAll(CharCollection c)
          Removes all of my elements that are contained in the specified collection (optional operation).
 boolean removeElement(char element)
          Removes a single occurrence of the specified element (optional operation).
 char removeElementAt(int index)
          Removes the element at the specified position in (optional operation).
 boolean retainAll(CharCollection c)
          Removes all of my elements that are not contained in the specified collection (optional operation).
 char set(int index, char element)
          Replaces the element at the specified position in me with the specified element (optional operation).
 CharList subList(int fromIndex, int toIndex)
          Returns a view of the elements within me between the specified fromIndex, inclusive, and toIndex, exclusive.
 
Methods inherited from class org.apache.commons.collections.primitives.decorators.BaseProxyCharList
get, getProxiedCollection, getProxiedList, indexOf, lastIndexOf
 
Methods inherited from class org.apache.commons.collections.primitives.decorators.BaseProxyCharCollection
contains, containsAll, equals, hashCode, isEmpty, size, toArray, toArray, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.commons.collections.primitives.CharList
equals, hashCode
 
Methods inherited from interface org.apache.commons.collections.primitives.CharCollection
contains, containsAll, isEmpty, size, toArray, toArray
 

Constructor Detail

BaseUnmodifiableCharList

BaseUnmodifiableCharList()
Method Detail

add

public final void add(int index,
                      char element)
Description copied from interface: CharList
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 CharList
Overrides:
add in class BaseProxyCharList
Parameters:
index - the index at which to insert the element
element - the value to insert

addAll

public final boolean addAll(int index,
                            CharCollection collection)
Description copied from interface: CharList
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 CharList
Overrides:
addAll in class BaseProxyCharList
Parameters:
index - the index at which to insert the first element from the specified collection
collection - the CharCollection of elements to add
Returns:
true iff I changed as a result of this call

removeElementAt

public final char removeElementAt(int index)
Description copied from interface: CharList
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 CharList
Overrides:
removeElementAt in class BaseProxyCharList
Parameters:
index - the index of the element to remove
Returns:
the value of the element that was removed

set

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

Specified by:
set in interface CharList
Overrides:
set in class BaseProxyCharList
Parameters:
index - the index of the element to change
element - the value to be stored at the specified position
Returns:
the value previously stored at the specified position

add

public final boolean add(char element)
Description copied from interface: CharCollection
Ensures that I contain the specified element (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 CharCollection
Specified by:
add in interface CharList
Overrides:
add in class BaseProxyCharCollection
Parameters:
element - the value whose presence within me is to be ensured
Returns:
true iff I changed as a result of this call

addAll

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

Specified by:
addAll in interface CharCollection
Overrides:
addAll in class BaseProxyCharCollection
Parameters:
c - the collection of elements whose presence within me is to be ensured
Returns:
true iff I changed as a result of this call

clear

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

Specified by:
clear in interface CharCollection
Overrides:
clear in class BaseProxyCharCollection

removeAll

public final boolean removeAll(CharCollection c)
Description copied from interface: CharCollection
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 CharCollection
Overrides:
removeAll in class BaseProxyCharCollection
Parameters:
c - the collection of elements to remove
Returns:
true iff I contained the at least one of the specified elements, in other words, returns true iff I changed as a result of this call

removeElement

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

Specified by:
removeElement in interface CharCollection
Overrides:
removeElement in class BaseProxyCharCollection
Parameters:
element - the element to remove, if present
Returns:
true iff I contained the specified element, in other words, iff I changed as a result of this call

retainAll

public final boolean retainAll(CharCollection c)
Description copied from interface: CharCollection
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 CharCollection
Overrides:
retainAll in class BaseProxyCharCollection
Parameters:
c - the collection of elements to retain
Returns:
true iff I changed as a result of this call

subList

public final CharList subList(int fromIndex,
                              int toIndex)
Description copied from interface: CharList
Returns a view of the elements within me between the specified fromIndex, inclusive, and toIndex, exclusive. The returned CharList 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 CharList
Overrides:
subList in class BaseProxyCharList
Parameters:
fromIndex - the smallest index (inclusive) in me that appears in the returned list
toIndex - the largest index (exclusive) in me that appears in the returned list
Returns:
a view of this list from fromIndex (inclusive) to toIndex (exclusive)

iterator

public final CharIterator iterator()
Description copied from interface: CharCollection
Returns an iterator over all my elements. This base interface places no constraints on the order in which the elements are returned by the returned iterator.

Specified by:
iterator in interface CharCollection
Specified by:
iterator in interface CharList
Overrides:
iterator in class BaseProxyCharCollection
Returns:
an iterator over all my elements.

listIterator

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

Specified by:
listIterator in interface CharList
Overrides:
listIterator in class BaseProxyCharList

listIterator

public CharListIterator listIterator(int index)
Description copied from interface: CharList
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 CharList
Overrides:
listIterator in class BaseProxyCharList


Copyright (c) 2002-2003 - Apache Software Foundation