System.Collections.ObjectModel

Class ReadOnlyCollection<T>

java.lang.Object

System.Collections.ObjectModel.ReadOnlyCollection<T>

Type Parameters:

T - The type of elements in the collection.

All Implemented Interfaces:

java.lang.Iterable<T>

Direct Known Subclasses:

GamerCollection, ModelBoneCollection, ModelEffectCollection, ModelMeshCollection, ModelMeshPartCollection

public class ReadOnlyCollection<T>
extends java.lang.Object
implements java.lang.Iterable<T>

Provides the base class for a generic read-only collection.

Author:

Halofreak1990

Constructor Summary

Constructors

Constructor and Description
ReadOnlyCollection(java.util.List<T> list) Initializes a new instance of the System.Collections.ObjectModel.ReadOnlyCollection class that is a read-only wrapper around the specified list.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	Contains(T value) Determines whether an element is in the System.Collections.ObjectModel.ReadOnlyCollection.
void	CopyTo(T[] array, int index) Copies the entire System.Collections.ObjectModel.ReadOnlyCollection to a compatible one-dimensional System.Array, starting at the specified index of the target array.
int	Count() Gets the number of elements contained in the System.Collections.ObjectModel.ReadOnlyCollection instance.
T	get(int index) Gets the element at the specified index.
protected java.util.List<T>	getItems() Returns the System.Collections.Generic.IList that the System.Collections.ObjectModel.ReadOnlyCollection wraps.
int	IndexOf(T value) Searches for the specified object and returns the zero-based index of the first occurrence within the entire System.Collections.ObjectModel.ReadOnlyCollection.
java.util.Iterator<T>	iterator() Returns an iterator that iterates through the System.Collections.ObjectModel.ReadOnlyCollection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadOnlyCollection

public ReadOnlyCollection(java.util.List<T> list)

Initializes a new instance of the System.Collections.ObjectModel.ReadOnlyCollection class that is a read-only wrapper around the specified list.

Parameters:

list - The list to wrap.

Throws:

ArgumentNullException - list is null.

Method Detail

Count

public int Count()

Gets the number of elements contained in the System.Collections.ObjectModel.ReadOnlyCollection instance.

getItems

protected java.util.List<T> getItems()

Returns the System.Collections.Generic.IList that the System.Collections.ObjectModel.ReadOnlyCollection wraps.

Returns:

The System.Collections.Generic.IList that the System.Collections.ObjectModel.ReadOnlyCollection wraps.

get

public T get(int index)

Gets the element at the specified index.

Parameters:

index - The zero-based index of the element to get.

Returns:

The element at the specified index.

Throws:

ArgumentOutOfRangeException - index is less than zero.-or-index is equal to or greater than System.Collections.ObjectModel.ReadOnlyCollection.count.

Contains

public boolean Contains(T value)

Determines whether an element is in the System.Collections.ObjectModel.ReadOnlyCollection.

Parameters:

value - The object to locate in the System.Collections.ObjectModel.ReadOnlyCollection. The value can be null for reference types.

Returns:

true if value is found in the System.Collections.ObjectModel.ReadOnlyCollection; otherwise, false.

CopyTo

public void CopyTo(T[] array,
          int index)

Copies the entire System.Collections.ObjectModel.ReadOnlyCollection to a compatible one-dimensional System.Array, starting at the specified index of the target array.

Parameters:

array - The one-dimensional array that is the destination of the elements copied from System.Collections.ObjectModel.ReadOnlyCollection. The System.Array must have zero-based indexing.

index - The zero-based index in array at which copying begins.

iterator

public java.util.Iterator<T> iterator()

Returns an iterator that iterates through the System.Collections.ObjectModel.ReadOnlyCollection.

Specified by:

iterator in interface java.lang.Iterable<T>

IndexOf

public int IndexOf(T value)

Searches for the specified object and returns the zero-based index of the first occurrence within the entire System.Collections.ObjectModel.ReadOnlyCollection.

Parameters:

value - The object to locate in the System.Collections.Generic.List. The value can be null for reference types.

Returns:

The zero-based index of the first occurrence of item within the entire System.Collections.ObjectModel.ReadOnlyCollection, if found; otherwise, -1.