rydeen
クラス Arguments

java.lang.Object
  rydeen.Arguments

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

Serializable, Iterable<Argument>

public class Arguments
extends Object
implements Iterable<Argument>, Serializable

処理器のパラメータを取りまとめるクラスです． このクラスは複数のArgumentを管理します．

作成者:

Haruaki Tamada

関連項目:

Argument, 直列化された形式

コンストラクタの概要

Arguments()
空のArgumentを持つオブジェクトを構築します．

Arguments(Argument[] args)
引数に与えられたArgumentを持つオブジェクトを構築します．

Arguments(Arguments args)
セルフコンストラクタ．引数に与えられたArgumentsが持っている全てのArgument を保持するオブジェクトを構築します．

メソッドの概要

int	getArgumentCount() このオブジェクトが保持するArgumentの数を返します．返される値は必ず0以上になります．
String	getDescription(String name) 与えられた名前に割り当てられたArgumentの解説を返します．
String	getValue(String name) 与えられた名前に割り当てられたArgumentの値を返します．値が存在しなかったり， hasArgument(name) がfalseを返す場合，nullを返します．
String	getValue(String name, String defaultValue) 与えられた名前に割り当てられたArgumentの値を返します．
boolean	hasArgument(String name) 与えられた名前のArgumentをこのオブジェクトが持っていれば，trueを返し， 持っていなければfalseを返します．
Iterator<Argument>	iterator() このオブジェクトが持つArgumentの列挙を返します．
void	merge(Arguments args) 与えられた Arguments とこの Arguments を統合します．両方の Arguments に同じ名前の異なる値があった場合，このArgumentsにある値が保持されます．
void	mergeOverwrite(Arguments args) 与えられた Arguments とこの Arguments を統合します．
void	putValue(Argument arg) 引数のargを新たなArgumentの1つとして登録します．
void	putValue(String name, String value) Argumentに値を割り当てます． nameが存在しない場合は新たなArgumentが作成されます．
void	putValue(String name, String value, String description) Argumentに値を割り当てます．
boolean	removeArgument(String name) nameが表す引数を削除します．
void	setDescription(String name, String description) Argumentの解説を設定します．与えられた名前のArgumentが設定されていない場合， name がnullの場合は NullPointerExceptionが投げられます．

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

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

コンストラクタの詳細

Arguments

public Arguments()

空のArgumentを持つオブジェクトを構築します．

Arguments

public Arguments(Arguments args)

セルフコンストラクタ．引数に与えられたArgumentsが持っている全てのArgument を保持するオブジェクトを構築します．

Arguments

public Arguments(Argument[] args)

引数に与えられたArgumentを持つオブジェクトを構築します．

メソッドの詳細

iterator

public Iterator<Argument> iterator()

このオブジェクトが持つArgumentの列挙を返します．

定義:

インタフェース Iterable<Argument> 内の iterator

merge

public void merge(Arguments args)

与えられた Arguments とこの Arguments を統合します．両方の Arguments に同じ名前の異なる値があった場合，このArgumentsにある値が保持されます．

パラメータ:

args -

関連項目:

mergeOverwrite(Arguments)

mergeOverwrite

public void mergeOverwrite(Arguments args)

与えられた Arguments とこの Arguments を統合します． 両方の Arguments に同じ名前の異なる値があった場合， 与えられた Arguments の値でこのArgumentsの値が上書きされます．

パラメータ:

args -

hasArgument

public boolean hasArgument(String name)

与えられた名前のArgumentをこのオブジェクトが持っていれば，trueを返し， 持っていなければfalseを返します． オブジェクトを持っているとは，このArgumentsオブジェクトに 指定された名前を持つ値が設定されていることです．その値がnullの場合もあり得ます．

引数にnullが与えられれば，NullPointerExceptionが投げられます．

パラメータ:

name - 存在を確認する引数の名前

戻り値:

存在していればtrue, 存在していなければ false．

getValue

public String getValue(String name,
                       String defaultValue)

与えられた名前に割り当てられたArgumentの値を返します．

nameに引数が設定されていなかった場合(nameに対応する値がnullの場合)， defaultValueを返します．

hasArgument(name)がfalseを返す場合， このメソッドはnullを返します．

nameがnullの場合，NullPointerExceptionが投げられます．

パラメータ:

name - 値を取得するArgumentの名前

defaultValue - 指定したArgumentに値が割り当てられていなかった場合に返すデフォルト値

戻り値:

Argumentに割り当てられた値．値がnullであれば，第２引数に渡されたdefaultValue．

getDescription

public String getDescription(String name)

与えられた名前に割り当てられたArgumentの解説を返します．

hasArgument(name)がfalseを返す場合や， 解説が設定されていなかった場合はnullを返します．

引数にnullが与えられた場合，NullPointerExceptionが投げられます．

パラメータ:

name - 解説を取得するArgumentの名前

戻り値:

指定されたArgumentの解説．

getValue

public String getValue(String name)

与えられた名前に割り当てられたArgumentの値を返します．値が存在しなかったり， hasArgument(name) がfalseを返す場合，nullを返します．

getValue(name, null)．

パラメータ:

name - 値を取得するArgumentの名前

戻り値:

Argumentの名前に割り当てられた値．

setDescription

public void setDescription(String name,
                           String description)

Argumentの解説を設定します．与えられた名前のArgumentが設定されていない場合， name がnullの場合は NullPointerExceptionが投げられます．

パラメータ:

name - 解説を設定しようとするArgumentの名前

description - 新たに設定する解説

putValue

public void putValue(Argument arg)

引数のargを新たなArgumentの1つとして登録します．

パラメータ:

arg - 新たに登録するArgument．

putValue

public void putValue(String name,
                     String value)

Argumentに値を割り当てます． nameが存在しない場合は新たなArgumentが作成されます．

nameがnullの場合，NullPointerExceptionが投げられます． valueがnullの場合，Argumentの値がnullとして設定されます．

nameに割り当てられたArgumentが存在した場合，値が変更されるだけで，解説には影響を与えません．

putValue

public void putValue(String name,
                     String value,
                     String description)

Argumentに値を割り当てます．

nameがnullの場合，NullPointerExceptionが投げられます． value，descriptionがnullの場合，nullで上書きされます．

getArgumentCount

public int getArgumentCount()

このオブジェクトが保持するArgumentの数を返します．返される値は必ず0以上になります．

removeArgument

public boolean removeArgument(String name)

nameが表す引数を削除します．

削除に成功した場合はtrueを返します． hasArgument(name)がfalseを返す場合は このメソッドもfalseを返します．