The Jakarta Project < Tools - View >

Velocity Tools

VelocityView

VelocityView Tools

その他のサブプロジェクト

ParameterParser リファレンスドキュメント
       

ServletRequest のパラメータをパースするビューツールです。

Class
 org.apache.velocity.tools.view.tools.ParameterParser
Name
 $params (Velocityコンテキスト内での推奨名)
Toolbox設定例
 
<tool>
  <key>params</key>
  <scope>request</scope>
  <class>org.apache.velocity.tools.view.tools.ParameterParser</class>
</tool>
作者
 Nathan Bubna
Method Overview
exists() 指定されたキーに対応するパラメータが存在する場合 true を返却します。
getString() 指定されたサーブレットリクエストのパラメータを String 形式で返却します。
getBoolean() 指定されたサーブレットリクエストのパラメータを Boolean オブジェクト、またはプリミティブの boolean 形式で返却します。
getNumber() 指定されたサーブレットリクエストのパラメータを Number オブジェクトとして返却します。
getInt() 指定されたサーブレットリクエストのパラメータを int として返却します。
getDouble() 指定されたサーブレットリクエストのパラメータを double として返却します。
getStrings() 指定されたサーブレットリクエストの全てのパラメータを String の配列形式で返却します。
getNumbers() 指定されたサーブレットリクエストの全てのパラメータを Number の配列形式で返却します。
getInts() 指定されたサーブレットリクエストの全てのパラメータを int の配列形式で返却します。
getDoubles() 指定されたサーブレットリクエストの全てのパラメータを double の配列形式で返却します。
exists()
       

指定されたキーに対応するパラメータが存在する場合 true を返却します。

boolean exists(String key)

Parameters
key
問い合わせを行うパラメータのキー
Returns
指定されたキーに対応するパラメータが存在する場合 true 、 パラメータが存在しない、または値を持っていない場合 false

getString()
       

指定されたサーブレットリクエストのパラメータを String 形式で返却します。

String get(String key)

String getString(String key)

String getString(String key, String alternate)

Parameters
key
要求するパラメータのキー
alternate
代替値
Returns
指定されたキーに一致するパラメータの値。 一致するパラメータが無かった場合、指定された代替値が返却されます。 代替値が指定されておらず、要求されたパラメータが見つからなかった場合には null が返却されます。

getBoolean()
       

指定されたサーブレットリクエストのパラメータを Boolean オブジェクト、またはプリミティブの boolean 形式で返却します。

Boolean getBoolean(String key)

Boolean getBoolean(String key, Boolean alternate)

boolean getBoolean(String key, boolean alternate)

Parameters
key
要求するパラメータのキー
alternate
代替値
Returns
指定されたキーに一致するパラメータの値を表す Boolean オブジェクト、またはプリミティブの boolean を返却します。 一致するパラメータが無かった場合、指定された代替値が返却されます。 代替値が指定されておらず、要求されたパラメータが見つからなかった場合には null が返却されます。

getNumber()
       

指定されたサーブレットリクエストのパラメータを Number オブジェクトとして返却します。

Number getNumber(String key)

Number getNumber(String key, Number alternate)

Parameters
key
要求するパラメータのキー
alternate
代替値
Returns
指定されたキーに一致するパラメータの値を表す java.lang.Number オブジェクトを返却します。 一致するパラメータが無かった場合、指定された代替値が返却されます。 代替値が指定されておらず、要求されたパラメータが見つからなかった場合には null が返却されます。

getInt()
       

指定されたサーブレットリクエストのパラメータを int として返却します。

int getInt(String key, int alternate)

Parameters
key
要求するパラメータのキー
alternate
代替値
Returns
指定されたキーに一致するパラメータの値を表す int を返却します。 一致するパラメータが無かった場合、指定された代替値が返却されます。

getDouble()
       

指定されたサーブレットリクエストのパラメータを double として返却します。

double getDouble(String key, double alternate)

Parameters
key
要求するパラメータのキー
alternate
代替値
Returns
指定されたキーに一致するパラメータの値を表す double を返却します。 一致するパラメータが無かった場合、指定された代替値が返却されます。

getStrings()
       

指定されたサーブレットリクエストの全てのパラメータを String の配列形式で返却します。

String[] getStrings(String key)

Parameters
key
要求するパラメータのキー
Returns
指定されたキーに一致するパラメータの全ての値を表す String の配列。 パラメータが無かった場合、 null が返却されます。

getNumbers()
       

指定されたサーブレットリクエストの全てのパラメータを Number の配列形式で返却します。

Number[] getNumbers(String key)

Parameters
key
要求するパラメータのキー
Returns
指定されたキーに一致するパラメータの全ての値を表す java.lang.Number の配列。 パラメータが無かった場合、 null が返却されます。

getInts()
       

指定されたサーブレットリクエストの全てのパラメータを int の配列形式で返却します。

int[] getInts(String key)

Parameters
key
要求するパラメータのキー
Returns
指定されたキーに一致するパラメータの全ての値を表す int の配列。 パラメータが無かった場合、 null が返却されます。

getDoubles()
       

指定されたサーブレットリクエストの全てのパラメータを double の配列形式で返却します。

double[] getDoubles(String key)

Parameters
key
要求するパラメータのキー
Returns
指定されたキーに一致するパラメータの全ての値を表す double の配列。 パラメータが無かった場合、 null が返却されます。


[訳注: この文書は 木村 貴由 Shinobu Kawai が翻訳しました。 日本語訳に対するコメントがあれば、report@jajakarta.orgに送って下さい。]
Copyright © 1999-2003, Apache Software Foundation