パッケージ org.opengion.fukurou.util

クラス Attributes

java.lang.Object

org.opengion.fukurou.util.Attributes

public final class Attributes
extends Object

Attributes.java は、String 型ｷｰにString型値を Map するｸﾗｽです。 HTMLのPOST/GET等の受け渡しや、String型の引数が多い場合に効果があります。 特に、getAttributes( String[] param ) による属性ﾘｽﾄ作成は、 HTMLﾀｸﾞの属性定義を行う上で、非常に便利に利用できます。 ※ 6.1.1.0 (2015/01/17) StringBuilder と同様、set ﾒｿｯﾄﾞ , add ﾒｿｯﾄﾞの戻り値に、自分自身を戻します。 これにより、連結処理できるようにします。 この実装は同期化されません。

導入されたバージョン:

JDK5.0,

コンストラクタの概要

コンストラクタ

コンストラクタ	説明
Attributes()	ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ
Attributes(Attributes att)	Attributesｵﾌﾞｼﾞｪｸﾄ を与えて新しく作成するｺﾝｽﾄﾗｸﾀｰ

メソッドの概要

修飾子とタイプ	メソッド	説明
Attributes	add(String key, String value)	指定された値と指定されたｷｰをこのﾏｯﾌﾟに追加します ﾏｯﾌﾟ自身のｷｰは、ﾕﾆｰｸである為、既存の値に対して、 新しく値を追加します。
Attributes	add(String key, String value, String sepa)	指定された値と指定されたｷｰをこのﾏｯﾌﾟに追加します class属性や、style属性など、同一ｷｰに対して、複数の値をつなげる場合に 使用します。
void	clear()	ﾏｯﾌﾟからﾏｯﾋﾟﾝｸﾞをすべて削除します。
String	get(String key)	ﾏｯﾌﾟが指定のｷｰをﾏｯﾌﾟする値を返します。
String	getAttribute()	ﾏｯﾌﾟに含まれているｷｰと属性のﾍﾟｱを ﾀｸﾞの属性ﾘｽﾄの形式ですべて返します。
String	getAttribute(Set<String> keys)	ﾏｯﾌﾟに含まれているｷｰと属性のﾍﾟｱを ﾀｸﾞの属性ﾘｽﾄの形式で返します。
String	remove(String key)	このｷｰにﾏｯﾋﾟﾝｸﾞがある場合に、そのﾏｯﾋﾟﾝｸﾞをﾏｯﾌﾟから削除します。
Attributes	set(String key, String value)	指定された値と指定されたｷｰをこのﾏｯﾌﾟに関連付けます 指定されたｷｰに、null を関連付けることはできません。
Attributes	set(String key, String value, String def)	指定された値と指定されたｷｰをこのﾏｯﾌﾟに関連付けます set( String key,String value ) との違いは、value が null の場合に、def を代わりにｾｯﾄすることです。
Attributes	set(Attributes att)	Attributes 属性を、既存の属性に上書き追加します。
int	size()	ﾏｯﾌﾟ内のｷｰと値のﾏｯﾋﾟﾝｸﾞの数を返します。
String	toString()	このｵﾌﾞｼﾞｪｸﾄの文字列表現を返します。
void	useStrict(boolean flag)	厳密にﾁｪｯｸするかどうか[true/false]を指定します(初期値:true)。

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

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

コンストラクタの詳細

Attributes

public Attributes()

ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ

変更履歴:

6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。

Attributes

public Attributes(Attributes att)

Attributesｵﾌﾞｼﾞｪｸﾄ を与えて新しく作成するｺﾝｽﾄﾗｸﾀｰ

パラメータ:

att - Attributesｵﾌﾞｼﾞｪｸﾄ

変更履歴:

6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。

メソッドの詳細

clear

public void clear()

ﾏｯﾌﾟからﾏｯﾋﾟﾝｸﾞをすべて削除します。

useStrict

public void useStrict(boolean flag)

厳密にﾁｪｯｸするかどうか[true/false]を指定します(初期値:true)。 内部のHTMLﾀｸﾞの属性ﾘｽﾄに 指定されているｷｰのみ使用したい場合は、true(初期値) を指定します。 指定されていないｷｰを使用したい場合は、false を指定します。

パラメータ:

flag - 厳密ﾁｪｯｸﾌﾗｸﾞ [true:厳密/false:甘い]

変更履歴:

8.5.3.0 (2023/09/08) DynamicAttributes対応

get

public String get(String key)

ﾏｯﾌﾟが指定のｷｰをﾏｯﾌﾟする値を返します。 ﾏｯﾌﾟがこのｷｰのﾏｯﾋﾟﾝｸﾞを保持していない場合は null を返します。戻り値の null は、ﾏｯﾌﾟがｷｰのﾏｯﾋﾟﾝｸﾞを 保持していないことを示すとはかぎりません。つまり、ﾏｯﾌﾟが 明示的にｷｰを null にﾏｯﾌﾟすることもあります。

パラメータ:

key - 関連付けられた値が返されるｷｰ(大文字小文字は同値)

戻り値:

ﾏｯﾌﾟが、指定されたｷｰにﾏｯﾋﾟﾝｸﾞしている値。 このｷｰに対するﾏｯﾋﾟﾝｸﾞがﾏｯﾌﾟにない場合は null

set

public Attributes set(String key,
 String value)

指定された値と指定されたｷｰをこのﾏｯﾌﾟに関連付けます 指定されたｷｰに、null を関連付けることはできません。 (もちろん、""：ｾﾞﾛｽﾄﾘﾝｸﾞ は登録できます。) なぜなら、getAttribute( String[] keys ) 等で値が null の ｷｰは、取得できない為です。 また、すでに何らかの値がｾｯﾄされている所に、null をｾｯﾄした 場合は、前の値をなにも変更しません。 通常、値をｸﾘｱしたい場合は、remove( String key ) を利用してください。

パラメータ:

key - 指定される値が関連付けられるｷｰ(大文字小文字は同値)

value - 指定されるｷｰに関連付けられる値

戻り値:

自分自身

変更履歴:

6.1.1.0 (2015/01/17) 戻り値に、自分自身を返すようにします。

このﾒｿｯﾄﾞは、nullを返しません

set

public Attributes set(String key,
 String value,
 String def)

指定された値と指定されたｷｰをこのﾏｯﾌﾟに関連付けます set( String key,String value ) との違いは、value が null の場合に、def を代わりにｾｯﾄすることです。 ただし、value が null で、def も null の場合は、 なにもｾｯﾄされません。

パラメータ:

key - 指定される値が関連付けられるｷｰ(大文字小文字は同値)

value - 指定されるｷｰに関連付けられる値

def - value が null の場合にｷｰに関連付けられる値

戻り値:

自分自身

変更履歴:

6.1.1.0 (2015/01/17) 戻り値に、自分自身を返すようにします。

このﾒｿｯﾄﾞは、nullを返しません

set

public Attributes set(Attributes att)

Attributes 属性を、既存の属性に上書き追加します。 引数 att が null の場合は、何もしません。 内部の Map に直接書き込みますので、すでに同一ｷｰの属性が存在している場合は、 上書きで置き換えます。 つまり、初期値を設定する場合は、最初に呼び出します。引数で設定された最新の値を 使用する場合は、最後に設定します。 ただし、#add(String,String) は、既存のｷｰに値を追記していきますので、これらより 後に設定しないと、上書きされてしまいますので、ご注意ください。 従来の、#addAttributes( Attributes ) の代替えﾒｿｯﾄﾞです。

パラメータ:

att - Attributes属性

戻り値:

自分自身

変更履歴:

6.1.1.0 (2015/01/17) 戻り値に、自分自身を返すようにします。

このﾒｿｯﾄﾞは、nullを返しません

add

public Attributes add(String key,
 String value)

指定された値と指定されたｷｰをこのﾏｯﾌﾟに追加します ﾏｯﾌﾟ自身のｷｰは、ﾕﾆｰｸである為、既存の値に対して、 新しく値を追加します。 追加する方法は、値の文字列の結合です。このﾒｿｯﾄﾞでは、 ﾃﾞﾌｫﾙﾄのｽﾍﾟｰｽで結合します。 値が null または、すでにそのｷｰに同一の値が関連付けられている場合は、 何もしません。

パラメータ:

key - 指定される値が関連付けられるｷｰ(大文字小文字は同値)

value - 指定されるｷｰの値に、追加される値

戻り値:

自分自身

変更履歴:

6.1.1.0 (2015/01/17) 戻り値に、自分自身を返すようにします。

このﾒｿｯﾄﾞは、nullを返しません

add

public Attributes add(String key,
 String value,
 String sepa)

指定された値と指定されたｷｰをこのﾏｯﾌﾟに追加します class属性や、style属性など、同一ｷｰに対して、複数の値をつなげる場合に 使用します。 ﾏｯﾌﾟ自身のｷｰは、ﾕﾆｰｸである為、既存の値に対して、 新しく値を追加します。 追加する方法は、値の文字列の結合です。このﾒｿｯﾄﾞでは、 引数 sepa で文字列を結合します。 値が null または、sepa が null または、すでにそのｷｰに 同一の値が関連付けられている場合は、何もしません。

パラメータ:

key - 指定される値が関連付けられるｷｰ(大文字小文字は同値)

value - 指定されるｷｰの値に、追加される値

sepa - 値を連結するときの文字列

戻り値:

自分自身

変更履歴:

6.1.1.0 (2015/01/17) 戻り値に、自分自身を返すようにします。

このﾒｿｯﾄﾞは、nullを返しません

remove

public String remove(String key)

このｷｰにﾏｯﾋﾟﾝｸﾞがある場合に、そのﾏｯﾋﾟﾝｸﾞをﾏｯﾌﾟから削除します。

パラメータ:

key - ﾏｯﾋﾟﾝｸﾞがﾏｯﾌﾟから削除されるｷｰ(大文字小文字は同値)

戻り値:

このｷｰにﾏｯﾋﾟﾝｸﾞがある場合に、そのﾏｯﾋﾟﾝｸﾞをﾏｯﾌﾟから削除します 指定されたｷｰに関連した以前の値。key にﾏｯﾋﾟﾝｸﾞがなかった場合は null。

size

public int size()

ﾏｯﾌﾟ内のｷｰと値のﾏｯﾋﾟﾝｸﾞの数を返します。

戻り値:

ｲﾝﾀﾌｪｰｽ Map 内の size

getAttribute

public String getAttribute(Set<String> keys)

ﾏｯﾌﾟに含まれているｷｰと属性のﾍﾟｱを ﾀｸﾞの属性ﾘｽﾄの形式で返します。 key1="value1" key2="value2" key3="value3" .... の形式で、value が null の 場合は、key そのもののﾍﾟｱを出力しません。 value が空文字列 "" の場合は、key="" で出力します。 引数には、key として出力したい値をSetで渡します。

パラメータ:

keys - 指定 key のSet

戻り値:

ｷｰと属性のﾍﾟｱをﾀｸﾞの属性ﾘｽﾄの形式で返します

変更履歴:

8.5.3.0 (2023/09/08) DynamicAttributes対応

getAttribute

public String getAttribute()

ﾏｯﾌﾟに含まれているｷｰと属性のﾍﾟｱを ﾀｸﾞの属性ﾘｽﾄの形式ですべて返します。 なお、value が null の場合は、key そのもののﾍﾟｱを出力しません。 value が空文字列 "" の場合は、key="" で出力します。

戻り値:

ｷｰと属性のﾍﾟｱをﾀｸﾞの属性ﾘｽﾄの形式で返します

変更履歴:

6.0.4.0 (2014/11/28) 内部処理見直し。値の取得は、Mapから直接取得する。, 6.4.3.4 (2016/03/11) forﾙｰﾌﾟを、forEach ﾒｿｯﾄﾞに置き換えます。, 8.5.3.0 (2023/09/08) DynamicAttributes対応

このﾒｿｯﾄﾞは、nullを返しません

toString

public String toString()

このｵﾌﾞｼﾞｪｸﾄの文字列表現を返します。 基本的にﾃﾞﾊﾞｯｸﾞ目的に使用します。

オーバーライド:

toString クラス内 Object

戻り値:

ｵﾌﾞｼﾞｪｸﾄの文字列表現

このﾒｿｯﾄﾞは、nullを返しません