【C#入門】Queue.Peekメソッドの使い方をサンプルコードでわかりやすく解説

C#のQueue.Peek()メソッドは、キュー（Queue）の先頭にあるオブジェクトを削除せずにそのまま返すためのメソッドです。「先頭の要素を確認したいだけ」という場面で活用できます。似たメソッドにDequeueがありますが、Dequeueは先頭要素を返したうえでキューから除去するのに対し、Peekは要素を残したまま参照できるのが特徴です。

構文

Peekメソッドの構文は以下のとおりです。

public virtual object Peek ();

注意点

キューが空の状態でPeekメソッドを呼び出すと、InvalidOperationExceptionがスローされるので注意してください。呼び出す前にCountプロパティで要素数をチェックしておくと安全です。

使用例1：非ジェネリックなQueueの場合

まずはSystem.Collections名前空間のQueueクラスを使った例を見てみましょう。

using System;
using System.Collections;
public class Demo {
   public static void Main() {
      Queue queue = new Queue();
      queue.Enqueue("AB");
      queue.Enqueue("BC");
      queue.Enqueue("CD");
      queue.Enqueue("DE");
      queue.Enqueue("EF");
      queue.Enqueue("FG");
      queue.Enqueue("GH");
      queue.Enqueue("HI");
      Console.WriteLine("Queue...");
      IEnumerator demoEnum = queue.GetEnumerator();
      while (demoEnum.MoveNext()) {
         Console.WriteLine(demoEnum.Current);
      }
      Console.WriteLine("Queue element at the beginning = "+queue.Peek());
      Console.WriteLine("Is Queue synchronized? = "+queue.IsSynchronized);
      Queue queue2 = Queue.Synchronized(queue);
      Console.WriteLine("Is Queue synchronized now? = "+queue2.IsSynchronized);
   }
}

実行結果

上記のコードを実行すると、次のような出力が得られます。

Queue...
AB
BC
CD
DE
EF
FG
GH
HI
Queue element at the beginning = AB
Is Queue synchronized? = False
Is Queue synchronized now? = True

この例では、Enqueueメソッドで8つの文字列を追加した後、Peekメソッドを呼び出しています。出力を見ると、最初に追加した「AB」が先頭要素として返されていることがわかります。また、Queue.Synchronizedメソッドを使うことで、スレッドセーフな同期ラッパーを作成できることも確認できます。

使用例2：ジェネリックなQueue<T>の場合

続いて、型安全なSystem.Collections.Generic名前空間のQueue<T>クラスを使った例です。

using System;
using System.Collections.Generic;
public class Demo {
   public static void Main() {
      Queue<string> queue = new Queue<string>();
      queue.Enqueue("Gary");
      queue.Enqueue("Jack");
      queue.Enqueue("Ryan");
      queue.Enqueue("Kevin");
      queue.Enqueue("Mark");
      queue.Enqueue("Jack");
      queue.Enqueue("Ryan");
      queue.Enqueue("Kevin");
      Console.Write("Count of elements = ");
      Console.WriteLine(queue.Count);
      Console.WriteLine("Queue element at the beginning = "+queue.Peek());
      Console.WriteLine("Does the queue has element Jack? = "+queue.Contains("Jack"));
      queue.Clear();
      Console.Write("Count of elements (updated) = ");
      Console.WriteLine(queue.Count);
   }
}

実行結果

上記のコードを実行すると、次のような出力が得られます。

Count of elements = 8
Queue element at the beginning = Gary
Does the queue has element Jack? = True
Count of elements (updated) = 0

この例では、まずCountプロパティで要素数「8」を確認し、Peekメソッドで先頭要素「Gary」を取得しています。Containsメソッドによる要素の存在チェックや、Clearメソッドによる全要素の削除後には要素数が「0」になっていることも確認できます。

まとめ

• Queue.Peekメソッドは、キューの先頭要素を削除せずに取得する
• キューが空の場合はInvalidOperationExceptionがスローされる
• 要素も一緒に取り除きたい場合はDequeueメソッドを使用する
• 型安全性を高めたい場合は、非ジェネリックなQueueではなくQueue<T>の利用を推奨