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

java.lang.Object
  extended by org.apache.commons.collections.primitives.decorators.UnmodifiableByteList
All Implemented Interfaces:
Serializable, ByteCollection, ByteList

public final class UnmodifiableByteList
extends Object
implements Serializable

Since:
Commons Primitives 1.0
Version:
$Revision: 480463 $ $Date: 2006-11-29 09:15:23 +0100 (Wed, 29 Nov 2006) $
Author:
Rodney Waldhoff
See Also:
Serialized Form

Method Summary
 boolean add(byte element)
          Ensures that I contain the specified element (optional operation).
 void add(int index, byte element)
          Inserts the specified element at the specified position (optional operation).
 boolean addAll(ByteCollection c)
          Adds all of the elements in the specified collection to me (optional operation).
 boolean addAll(int index, ByteCollection 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(byte element)
          Returns true iff I contain the specified element.
 boolean containsAll(ByteCollection c)
          Returns true iff I contain all of the elements in the given collection.
 boolean equals(Object obj)
           
 byte get(int index)
          Returns the value of the element at the specified position within me.
protected  ByteCollection getProxiedCollection()
           
protected  ByteList getProxiedList()
           
 int hashCode()
           
 int indexOf(byte 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.
 ByteIterator iterator()
          Returns an iterator over all my elements.
 int lastIndexOf(byte element)
          Returns the index of the last occurrence of the specified element within me, or -1 if I do not contain the element.
 ByteListIterator listIterator()
          Returns a bidirectional iterator over all my elements, in the appropriate sequence.
 ByteListIterator listIterator(int index)
          Returns a bidirectional iterator over all my elements, in the appropriate sequence, starting at the specified position.
 boolean removeAll(ByteCollection c)
          Removes all of my elements that are contained in the specified collection (optional operation).
 boolean removeElement(byte element)
          Removes a single occurrence of the specified element (optional operation).
 byte removeElementAt(int index)
          Removes the element at the specified position in (optional operation).
 boolean retainAll(ByteCollection c)
          Removes all of my elements that are not contained in the specified collection (optional operation).
 byte set(int index, byte 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.
 ByteList subList(int fromIndex, int toIndex)
          Returns a view of the elements within me between the specified fromIndex, inclusive, and toIndex, exclusive.
 byte[] toArray()
          Returns an array containing all of my elements.
 byte[] toArray(byte[] a)
          Returns an array containing all of my elements, using the given array if it is large enough.
 String toString()
           
static ByteList wrap(ByteList list)
           
 
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.ByteList
equals, hashCode
 
Methods inherited from interface org.apache.commons.collections.primitives.ByteCollection
contains, containsAll, isEmpty, size, toArray, toArray
 

Method Detail

wrap

public static final ByteList wrap(ByteList list)

getProxiedList

protected ByteList getProxiedList()

add

public final void add(int index,
                      byte element)
Description copied from interface: ByteList
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 ByteList
Parameters:
index - the index at which to insert the element
element - the value to insert

addAll

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

removeElementAt

public final byte removeElementAt(int index)
Description copied from interface: ByteList
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 ByteList
Parameters:
index - the index of the element to remove
Returns:
the value of the element that was removed

set

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

Specified by:
set in interface ByteList
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(byte element)
Description copied from interface: ByteCollection
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 ByteCollection
Specified by:
add in interface ByteList
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(ByteCollection c)
Description copied from interface: ByteCollection
Adds all of the elements in the specified collection to me (optional operation).

Specified by:
addAll in interface ByteCollection
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: ByteCollection
Removes all my elements (optional operation). I will be empty after this method successfully returns.

Specified by:
clear in interface ByteCollection

removeAll

public final boolean removeAll(ByteCollection c)
Description copied from interface: ByteCollection
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 ByteCollection
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(byte element)
Description copied from interface: ByteCollection
Removes a single occurrence of the specified element (optional operation).

Specified by:
removeElement in interface ByteCollection
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(ByteCollection c)
Description copied from interface: ByteCollection
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 ByteCollection
Parameters:
c - the collection of elements to retain
Returns:
true iff I changed as a result of this call

subList

public final ByteList subList(int fromIndex,
                              int toIndex)
Description copied from interface: ByteList
Returns a view of the elements within me between the specified fromIndex, inclusive, and toIndex, exclusive. The returned ByteList 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 ByteList
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 ByteIterator iterator()
Description copied from interface: ByteCollection
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 ByteCollection
Specified by:
iterator in interface ByteList
Returns:
an iterator over all my elements.

listIterator

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

Specified by:
listIterator in interface ByteList

listIterator

public ByteListIterator listIterator(int index)
Description copied from interface: ByteList
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 ByteList

getProxiedCollection

protected final ByteCollection getProxiedCollection()

get

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

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

indexOf

public int indexOf(byte element)
Description copied from interface: ByteList
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 ByteList
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(byte element)
Description copied from interface: ByteList
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 ByteList
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(byte element)
Description copied from interface: ByteCollection
Returns true iff I contain the specified element.

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

containsAll

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

Specified by:
containsAll in interface ByteCollection
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: ByteCollection
Returns true iff I contain no elements.

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

size

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

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

toArray

public byte[] toArray()
Description copied from interface: ByteCollection
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 ByteCollection
Returns:
an array containing all my elements

toArray

public byte[] toArray(byte[] a)
Description copied from interface: ByteCollection
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 ByteCollection
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)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.