ReadOnlyCollectionBase.GetEnumerator 方法
返回循环访问 ReadOnlyCollectionBase 实例的枚举数。
**命名空间:**System.Collections
**程序集:**mscorlib(在 mscorlib.dll 中)
语法
声明
Public Overridable Function GetEnumerator As IEnumerator
用法
Dim instance As ReadOnlyCollectionBase
Dim returnValue As IEnumerator
returnValue = instance.GetEnumerator
public virtual IEnumerator GetEnumerator ()
public:
virtual IEnumerator^ GetEnumerator ()
public IEnumerator GetEnumerator ()
public function GetEnumerator () : IEnumerator
返回值
用于 ReadOnlyCollectionBase 实例的 IEnumerator。
备注
C# 语言的 foreach 语句(在 Visual Basic 中为 for each)隐藏了枚举数的复杂性。因此,建议使用 foreach,而不直接操作枚举数。
枚举数可用于读取集合中的数据,但不能用于修改基础集合。
最初,枚举数被定位于集合中第一个元素的前面。Reset 也将枚举数返回到此位置。在此位置上,未定义 Current。因此,在读取 Current 的值之前,必须调用 MoveNext 将枚举数提前到集合的第一个元素。
在调用 MoveNext 或 Reset 之前,Current 返回同一对象。MoveNext 将 Current 设置为下一个元素。
如果 MoveNext 越过集合的末尾,枚举数就会被放置在此集合中最后一个元素的后面,且 MoveNext 返回 false。当枚举数位于此位置时,对 MoveNext 的后续调用也返回 false。如果对 MoveNext 的上一次调用返回 false,则说明未定义 Current。若要再次将 Current 设置为集合的第一个元素,可以调用 Reset,然后再调用 MoveNext。
只要集合保持不变,枚举数就保持有效。如果对集合进行更改(如添加、修改或删除元素),则枚举数将失效且不可恢复,而且其行为是不确定的。
枚举数没有对集合的独占访问权;因此,枚举通过集合在本质上不是一个线程安全的过程。若要确保枚举过程中的线程安全,可以在整个枚举过程中锁定集合。若要允许多个线程访问集合以进行读写操作,则必须实现自己的同步。
此方法的运算复杂度为 O(1)。
示例
下面的代码示例实现 ReadOnlyCollectionBase 类。
Imports System
Imports System.Collections
Public Class ROCollection
Inherits ReadOnlyCollectionBase
Public Sub New(sourceList As IList)
InnerList.AddRange(sourceList)
End Sub 'New
Default Public ReadOnly Property Item(index As Integer) As [Object]
Get
Return InnerList(index)
End Get
End Property
Public Function IndexOf(value As [Object]) As Integer
Return InnerList.IndexOf(value)
End Function 'IndexOf
Public Function Contains(value As [Object]) As Boolean
Return InnerList.Contains(value)
End Function 'Contains
End Class 'ROCollection
Public Class SamplesCollectionBase
Public Shared Sub Main()
' Create an ArrayList.
Dim myAL As New ArrayList()
myAL.Add("red")
myAL.Add("blue")
myAL.Add("yellow")
myAL.Add("green")
myAL.Add("orange")
myAL.Add("purple")
' Create a new ROCollection that contains the elements in myAL.
Dim myCol As New ROCollection(myAL)
' Display the contents of the collection using For Each. This is the preferred method.
Console.WriteLine("Contents of the collection (using For Each):")
PrintValues1(myCol)
' Display the contents of the collection using the enumerator.
Console.WriteLine("Contents of the collection (using enumerator):")
PrintValues2(myCol)
' Display the contents of the collection using the Count property and the Item property.
Console.WriteLine("Contents of the collection (using Count and Item):")
PrintIndexAndValues(myCol)
' Search the collection with Contains and IndexOf.
Console.WriteLine("Contains yellow: {0}", myCol.Contains("yellow"))
Console.WriteLine("orange is at index {0}.", myCol.IndexOf("orange"))
Console.WriteLine()
End Sub 'Main
' Uses the Count property and the Item property.
Public Shared Sub PrintIndexAndValues(myCol As ROCollection)
Dim i As Integer
For i = 0 To myCol.Count - 1
Console.WriteLine(" [{0}]: {1}", i, myCol(i))
Next i
Console.WriteLine()
End Sub 'PrintIndexAndValues
' Uses the For Each statement which hides the complexity of the enumerator.
' NOTE: The For Each statement is the preferred way of enumerating the contents of a collection.
Public Shared Sub PrintValues1(myCol As ROCollection)
Dim obj As [Object]
For Each obj In myCol
Console.WriteLine(" {0}", obj)
Next obj
Console.WriteLine()
End Sub 'PrintValues1
' Uses the enumerator.
' NOTE: The For Each statement is the preferred way of enumerating the contents of a collection.
Public Shared Sub PrintValues2(myCol As ROCollection)
Dim myEnumerator As System.Collections.IEnumerator = myCol.GetEnumerator()
While myEnumerator.MoveNext()
Console.WriteLine(" {0}", myEnumerator.Current)
End While
Console.WriteLine()
End Sub 'PrintValues2
End Class 'SamplesCollectionBase
'This code produces the following output.
'
'Contents of the collection (using For Each):
' red
' blue
' yellow
' green
' orange
' purple
'
'Contents of the collection (using enumerator):
' red
' blue
' yellow
' green
' orange
' purple
'
'Contents of the collection (using Count and Item):
' [0]: red
' [1]: blue
' [2]: yellow
' [3]: green
' [4]: orange
' [5]: purple
'
'Contains yellow: True
'orange is at index 4.
using System;
using System.Collections;
public class ROCollection : ReadOnlyCollectionBase {
public ROCollection( IList sourceList ) {
InnerList.AddRange( sourceList );
}
public Object this[ int index ] {
get {
return( InnerList[index] );
}
}
public int IndexOf( Object value ) {
return( InnerList.IndexOf( value ) );
}
public bool Contains( Object value ) {
return( InnerList.Contains( value ) );
}
}
public class SamplesCollectionBase {
public static void Main() {
// Create an ArrayList.
ArrayList myAL = new ArrayList();
myAL.Add( "red" );
myAL.Add( "blue" );
myAL.Add( "yellow" );
myAL.Add( "green" );
myAL.Add( "orange" );
myAL.Add( "purple" );
// Create a new ROCollection that contains the elements in myAL.
ROCollection myCol = new ROCollection( myAL );
// Display the contents of the collection using foreach. This is the preferred method.
Console.WriteLine( "Contents of the collection (using foreach):" );
PrintValues1( myCol );
// Display the contents of the collection using the enumerator.
Console.WriteLine( "Contents of the collection (using enumerator):" );
PrintValues2( myCol );
// Display the contents of the collection using the Count property and the Item property.
Console.WriteLine( "Contents of the collection (using Count and Item):" );
PrintIndexAndValues( myCol );
// Search the collection with Contains and IndexOf.
Console.WriteLine( "Contains yellow: {0}", myCol.Contains( "yellow" ) );
Console.WriteLine( "orange is at index {0}.", myCol.IndexOf( "orange" ) );
Console.WriteLine();
}
// Uses the Count property and the Item property.
public static void PrintIndexAndValues( ROCollection myCol ) {
for ( int i = 0; i < myCol.Count; i++ )
Console.WriteLine( " [{0}]: {1}", i, myCol[i] );
Console.WriteLine();
}
// Uses the foreach statement which hides the complexity of the enumerator.
// NOTE: The foreach statement is the preferred way of enumerating the contents of a collection.
public static void PrintValues1( ROCollection myCol ) {
foreach ( Object obj in myCol )
Console.WriteLine( " {0}", obj );
Console.WriteLine();
}
// Uses the enumerator.
// NOTE: The foreach statement is the preferred way of enumerating the contents of a collection.
public static void PrintValues2( ROCollection myCol ) {
System.Collections.IEnumerator myEnumerator = myCol.GetEnumerator();
while ( myEnumerator.MoveNext() )
Console.WriteLine( " {0}", myEnumerator.Current );
Console.WriteLine();
}
}
/*
This code produces the following output.
Contents of the collection (using foreach):
red
blue
yellow
green
orange
purple
Contents of the collection (using enumerator):
red
blue
yellow
green
orange
purple
Contents of the collection (using Count and Item):
[0]: red
[1]: blue
[2]: yellow
[3]: green
[4]: orange
[5]: purple
Contains yellow: True
orange is at index 4.
*/
using namespace System;
using namespace System::Collections;
public ref class ROCollection: public ReadOnlyCollectionBase
{
public:
ROCollection( IList^ sourceList )
{
InnerList->AddRange( sourceList );
}
property Object^ Item [int]
{
Object^ get( int index )
{
return (InnerList[ index ]);
}
}
int IndexOf( Object^ value )
{
return (InnerList->IndexOf( value ));
}
bool Contains( Object^ value )
{
return (InnerList->Contains( value ));
}
};
void PrintIndexAndValues( ROCollection^ myCol );
void PrintValues2( ROCollection^ myCol );
int main()
{
// Create an ArrayList.
ArrayList^ myAL = gcnew ArrayList;
myAL->Add( "red" );
myAL->Add( "blue" );
myAL->Add( "yellow" );
myAL->Add( "green" );
myAL->Add( "orange" );
myAL->Add( "purple" );
// Create a new ROCollection that contains the elements in myAL.
ROCollection^ myCol = gcnew ROCollection( myAL );
// Display the contents of the collection using the enumerator.
Console::WriteLine( "Contents of the collection (using enumerator):" );
PrintValues2( myCol );
// Display the contents of the collection using the Count property and the Item property.
Console::WriteLine( "Contents of the collection (using Count and Item):" );
PrintIndexAndValues( myCol );
// Search the collection with Contains and IndexOf.
Console::WriteLine( "Contains yellow: {0}", myCol->Contains( "yellow" ) );
Console::WriteLine( "orange is at index {0}.", myCol->IndexOf( "orange" ) );
Console::WriteLine();
}
// Uses the Count property and the Item property.
void PrintIndexAndValues( ROCollection^ myCol )
{
for ( int i = 0; i < myCol->Count; i++ )
Console::WriteLine( " [{0}]: {1}", i, myCol->Item[ i ] );
Console::WriteLine();
}
// Uses the enumerator.
void PrintValues2( ROCollection^ myCol )
{
System::Collections::IEnumerator^ myEnumerator = myCol->GetEnumerator();
while ( myEnumerator->MoveNext() )
Console::WriteLine( " {0}", myEnumerator->Current );
Console::WriteLine();
}
/*
This code produces the following output.
Contents of the collection (using enumerator):
red
blue
yellow
green
orange
purple
Contents of the collection (using Count and Item):
[0]: red
[1]: blue
[2]: yellow
[3]: green
[4]: orange
[5]: purple
Contains yellow: True
orange is at index 4.
*/
import System.*;
import System.Collections.*;
public class ROCollection extends ReadOnlyCollectionBase
{
public ROCollection(IList sourceList)
{
get_InnerList().AddRange(sourceList);
} //ROCollection
/** @property
*/
public Object get_Item(int index)
{
return get_InnerList().get_Item(index);
} //get_Item
public int IndexOf(Object value)
{
return get_InnerList().IndexOf(value);
} //IndexOf
public boolean Contains(Object value)
{
return get_InnerList().Contains(value);
} //Contains
} //ROCollection
public class SamplesCollectionBase
{
public static void main(String[] args)
{
// Create an ArrayList.
ArrayList myAL = new ArrayList();
myAL.Add("red");
myAL.Add("blue");
myAL.Add("yellow");
myAL.Add("green");
myAL.Add("orange");
myAL.Add("purple");
// Create a new ROCollection that contains the elements in myAL.
ROCollection myCol = new ROCollection(myAL);
// Display the contents of the collection using for. This is the
// preferred method.
Console.WriteLine("Contents of the collection (using for):");
PrintValues1(myCol);
// Display the contents of the collection using the enumerator.
Console.WriteLine("Contents of the collection (using enumerator):");
PrintValues2(myCol);
// Display the contents of the collection using the Count property and
// the Item property.
Console.WriteLine("Contents of the collection (using Count and Item):");
PrintIndexAndValues(myCol);
// Search the collection with Contains and IndexOf.
Console.WriteLine("Contains yellow: {0}",
(System.Boolean)myCol.Contains("yellow"));
Console.WriteLine("orange is at index {0}.",
(Int32)myCol.IndexOf("orange"));
Console.WriteLine();
} //main
// Uses the Count property and the Item property.
public static void PrintIndexAndValues(ROCollection myCol)
{
for(int i = 0; i < myCol.get_Count(); i++) {
Console.WriteLine(" [{0}]: {1}",(Int32)i, myCol.get_Item(i));
}
Console.WriteLine();
} //PrintIndexAndValues
// Uses the for statement which hides the complexity of the enumerator.
// NOTE: The for statement is the preferred way of enumerating the contents
// of a collection.
public static void PrintValues1(ROCollection myCol)
{
for (int iCtr = 0; iCtr < myCol.get_Count(); iCtr++ ) {
Object obj = myCol.get_Item(iCtr);
Console.WriteLine(" {0}", obj);
}
Console.WriteLine();
} //PrintValues1
// Uses the enumerator.
// NOTE: The for statement is the preferred way of enumerating the
// contents of a collection.
public static void PrintValues2(ROCollection myCol)
{
System.Collections.IEnumerator myEnumerator = myCol.GetEnumerator();
while(myEnumerator.MoveNext()) {
Console.WriteLine(" {0}", myEnumerator.get_Current());
}
Console.WriteLine();
} //PrintValues2
} //SamplesCollectionBase
/*
This code produces the following output.
Contents of the collection (using for):
red
blue
yellow
green
orange
purple
Contents of the collection (using enumerator):
red
blue
yellow
green
orange
purple
Contents of the collection (using Count and Item):
[0]: red
[1]: blue
[2]: yellow
[3]: green
[4]: orange
[5]: purple
Contains yellow: True
orange is at index 4.
*/
平台
Windows 98、Windows 2000 SP4、Windows Millennium Edition、Windows Server 2003、Windows XP Media Center Edition、Windows XP Professional x64 Edition、Windows XP SP2、Windows XP Starter Edition
.NET Framework 并不是对每个平台的所有版本都提供支持。有关受支持版本的列表,请参见系统要求。
版本信息
.NET Framework
受以下版本支持:2.0、1.1、1.0
请参见
参考
ReadOnlyCollectionBase 类
ReadOnlyCollectionBase 成员
System.Collections 命名空间
IEnumerator 接口