rydeen
クラス Summary

java.lang.Object
  rydeen.Summary

すべての実装されたインタフェース:

Iterable<Summary.Entry>

public class Summary
extends Object
implements Iterable<Summary.Entry>

ある処理器(Processor)の処理結果を扱うためのクラスです． 処理結果を出力するために用いられます．

サマリは複数のエントリから成り，1つのエントリにはキーとそれに対応する値が含まれる． エントリは追加された順序を保持します． キーは親子関係があり，階層は.で区切られます．このサマリのトップの階層は getProcessorIdメソッドで 返される処理器の名前です．

サマリ同士が階層関係を結ぶ場合もあります．

作成者:

Haruaki Tamada

入れ子のクラスの概要

static class

Summary.Entry サマリに追加するエントリを表すクラス．

コンストラクタの概要

Summary(String processorId)
指定された名前でサマリオブジェクトを作成します．

メソッドの概要

String	getEntry(String key) keyに対応する値を返します．keyに対応する値が存在しない場合はnullが返されます．
int	getEntryCount() このサマリに格納されているエントリの数を返します．
String	getProcessorId() 処理器のidを返します．
Iterator<Summary.Entry>	iterator() このサマリに格納されているエントリの列挙を返します．
void	putEntry(String key, String value) サマリに，1つのエントリを追加します．
void	removeEntry(String key) サマリから指定されたキーを持つエントリを削除します．
void	setProcessorId(String id) 処理器のIdを設定します．

クラス java.lang.Object から継承されたメソッド

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

コンストラクタの詳細

Summary

public Summary(String processorId)

指定された名前でサマリオブジェクトを作成します．

メソッドの詳細

setProcessorId

public void setProcessorId(String id)

処理器のIdを設定します．

idがnullのNullPointerExceptionが投げられます．

パラメータ:

id - 処理器のId

getProcessorId

public String getProcessorId()

処理器のidを返します．

戻り値:

処理器のid

putEntry

public void putEntry(String key,
                     String value)

サマリに，1つのエントリを追加します．

keyがnullの場合，valueがnullの場合はNullPointerExceptionが投げられます．

パラメータ:

key - 追加するエントリのキー

value - キーに対応する値

getEntry

public String getEntry(String key)

keyに対応する値を返します．keyに対応する値が存在しない場合はnullが返されます．

keyがnullの場合はNullPointerExceptionが投げられます．

パラメータ:

key - 取得したい値に対応付けられているキー．

戻り値:

keyに対応付けられた値．

removeEntry

public void removeEntry(String key)

サマリから指定されたキーを持つエントリを削除します． keyがnullの場合や，与えられたkeyに値が対応付けられていない場合は何も行いません．

パラメータ:

key - 削除するエントリのキー

getEntryCount

public int getEntryCount()

このサマリに格納されているエントリの数を返します．

戻り値:

このサマリオブジェクトが持つエントリの数．

iterator

public Iterator<Summary.Entry> iterator()

このサマリに格納されているエントリの列挙を返します．

定義:

インタフェース Iterable<Summary.Entry> 内の iterator