wisdom.core.application
インタフェース IRequestParser

既知の実装クラスの一覧:

ParameterParser

public interface IRequestParser

javax.servlet.http.ServletRequest をパースする汎用クラス・インターフェース。
2005/5/24 WA0037の追加

バージョン:

0.90, 1/1/2001

作成者:

Takao Kouda

フィールドの概要

static int	ATTRIBUTE パース出力に使用するキー。
static java.lang.String	ATTRIBUTE_NAME ResquestParser を HttpServletResponse の属性に設定するするキー値
static int	BASIC 認証タイプ
static java.lang.String	COMMAND 実行コマンドクラスをHttpServletRequestの属性に設定するキー値
static int	HEADER パース出力に使用するキー。
static int	PARAMETER パース出力に使用するキー。

メソッドの概要

java.lang.Object	getAttribute(java.lang.String key) 内包しているHttpServletRequestに設定された属性を取得します。
java.lang.Object	getAttribute(java.lang.String key, boolean allowNull) 内包しているHttpServletRequestに設定された属性を取得します。
RequestCommand	getCommand() このRequestParserを実行したコマンドクラスを取得します。
java.lang.String	getCommandName() このRequestParserを実行したコマンドクラス名を取得します。
java.lang.String	getContextPath() ContextPathを取得します。
double	getDouble(java.lang.String name) double型のパラメータを取得する
double	getDouble(java.lang.String name, double def) double型のパラメータを取得する 値が正しく受け取れない場合は省略値の設定が可能。
java.lang.String	getHeader(java.lang.String key) 内包しているHttpServletRequestに設定されたヘッダー情報を取得します。
java.lang.String	getHeader(java.lang.String key, boolean allowNull) 内包しているHttpServletRequestに設定されたヘッダー情報を取得します。
int	getInt(java.lang.String name) int型のパラメータを取得する
int	getInt(java.lang.String name, int def) int型のパラメータを取得する 値が正しく受け取れない場合は省略値の設定が可能。
java.util.Iterator	getParameterNames() HttpServletRequestのパラメータ名の一覧を返します。
Part	getPart(java.lang.String name) Partのパラメータを取得する
java.util.List	getPartArray(java.lang.String name) Partのパラメータを取得する
java.lang.String	getReqId() reqidを取得します
javax.servlet.http.HttpServletRequest	getRequest() HttpServletRequestのインスタンスを取得します。
java.lang.String	getString(java.lang.String name) String型のパラメータを取得します 戻り値はString#trim()が行われます。
java.lang.String	getString(java.lang.String name, java.lang.String def) String型のパラメータを取得します 値がない場合、defの値が戻され、値がある場合、戻り値はString#trim()が行われます。
java.lang.String[]	getStringArray(java.lang.String name) String型配列のパラメータを取得する このメソッドは戻り値がnullの場合、長さ0のStringオブジェクトを含んだ配列を戻します。
java.lang.String[]	getStringArrayWithNull(java.lang.String name) String型配列のパラメータを取得する このメソッドは戻り値がnullの場合、nullオブジェクトを戻します。
java.lang.String	getStringNoTrim(java.lang.String name) String型のパラメータを取得します
java.lang.String	getStringNoTrim(java.lang.String name, java.lang.String def) String型のパラメータを取得する 値が正しく受け取れない場合は省略値の設定が可能。
java.lang.String	parse() HttpServletRequestの内容を文字で返します。
java.lang.String	parse(int type) HttpServletRequestの内容を文字で返します。

フィールドの詳細

COMMAND

public static final java.lang.String COMMAND

実行コマンドクラスをHttpServletRequestの属性に設定するキー値

関連項目:

定数フィールド値

ATTRIBUTE_NAME

public static final java.lang.String ATTRIBUTE_NAME

ResquestParser を HttpServletResponse の属性に設定するするキー値

PARAMETER

public static final int PARAMETER

パース出力に使用するキー。

関連項目:

定数フィールド値

ATTRIBUTE

public static final int ATTRIBUTE

パース出力に使用するキー。

関連項目:

定数フィールド値

HEADER

public static final int HEADER

パース出力に使用するキー。

関連項目:

定数フィールド値

BASIC

public static final int BASIC

認証タイプ

関連項目:

定数フィールド値

メソッドの詳細

getString

public java.lang.String getString(java.lang.String name)
                           throws ParameterNotFoundException

String型のパラメータを取得します
戻り値はString#trim()が行われます。

パラメータ:

name - 取得するパラメータ名

戻り値:

String型で取得された値

例外:

ParameterNotFoundException - 引数で渡されたパラメータ数の変数がHttpServletRequestの中にない場合

getString

public java.lang.String getString(java.lang.String name,
                                  java.lang.String def)

String型のパラメータを取得します
値がない場合、defの値が戻され、値がある場合、戻り値はString#trim()が行われます。

パラメータ:

name - 取得するパラメータ名

def - 取得できなかった場合の省略値

戻り値:

String型で取得された値

getStringNoTrim

public java.lang.String getStringNoTrim(java.lang.String name)
                                 throws ParameterNotFoundException

String型のパラメータを取得します

パラメータ:

name - 取得するパラメータ名

戻り値:

String型で取得された値

例外:

ParameterNotFoundException - 引数で渡されたパラメータ数の変数がHttpServletRequestの中にない場合

getStringNoTrim

public java.lang.String getStringNoTrim(java.lang.String name,
                                        java.lang.String def)

String型のパラメータを取得する
値が正しく受け取れない場合は省略値の設定が可能。
取得できたパラメータ値は左右の空白は削除されません。

パラメータ:

name - 取得するパラメータ名

def - 取得できなかった場合の省略値

戻り値:

String型で取得された値

getInt

public int getInt(java.lang.String name)
           throws ParameterNotFoundException,
                  java.lang.NumberFormatException

int型のパラメータを取得する

パラメータ:

name - 取得するパラメータ名

戻り値:

int型で取得された値

例外:

ParameterNotFoundException - 引数で渡されたパラメータ数の変数がHttpServletRequestの中にない場合

java.lang.NumberFormatException

getInt

public int getInt(java.lang.String name,
                  int def)

int型のパラメータを取得する
値が正しく受け取れない場合は省略値の設定が可能。

パラメータ:

name - 取得するパラメータ名

def - 取得できなかった場合の省略値

戻り値:

int型で取得された値

getDouble

public double getDouble(java.lang.String name)
                 throws ParameterNotFoundException,
                        java.lang.NumberFormatException

double型のパラメータを取得する

パラメータ:

name - 取得するパラメータ名

戻り値:

doubleg型で取得された値

例外:

ParameterNotFoundException - 引数で渡されたパラメータ数の変数がHttpServletRequestの中にない場合

java.lang.NumberFormatException

getDouble

public double getDouble(java.lang.String name,
                        double def)

double型のパラメータを取得する
値が正しく受け取れない場合は省略値の設定が可能。

パラメータ:

name - 取得するパラメータ名

def - double 取得できなかった場合の省略値

戻り値:

double型で取得された値

getStringArray

public java.lang.String[] getStringArray(java.lang.String name)
                                  throws ParameterNotFoundException

String型配列のパラメータを取得する
このメソッドは戻り値がnullの場合、長さ0のStringオブジェクトを含んだ配列を戻します。

パラメータ:

name - 取得するパラメータ名

戻り値:

Stringの配列型で取得された値

例外:

ParameterNotFoundException - 引数で渡されたパラメータ数の変数がHttpServletRequestの中にない場合

getStringArrayWithNull

public java.lang.String[] getStringArrayWithNull(java.lang.String name)

String型配列のパラメータを取得する
このメソッドは戻り値がnullの場合、nullオブジェクトを戻します。

パラメータ:

name - 取得するパラメータ名

戻り値:

Stringの配列型で取得された値

例外:

ParameterNotFoundException - 引数で渡されたパラメータ数の変数がHttpServletRequestの中にない場合

導入されたバージョン:

2005/5/24 WA0037の追加

getPart

public Part getPart(java.lang.String name)
             throws ParameterNotFoundException

Partのパラメータを取得する

パラメータ:

name - 取得するパラメータ名

戻り値:

Part型で取得された値

例外:

ParameterNotFoundException - 引数で渡されたパラメータ数の変数がHttpServletRequestの中にない場合

getPartArray

public java.util.List getPartArray(java.lang.String name)
                            throws ParameterNotFoundException

Partのパラメータを取得する

パラメータ:

name - 取得するパラメータ名

戻り値:

Part型の配列（Liist）で取得された値

例外:

ParameterNotFoundException - 引数で渡されたパラメータ数の変数がHttpServletRequestの中にない場合

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

HttpServletRequestのインスタンスを取得します。

戻り値:

HttpServletRequest HttpServletRequest

getContextPath

public java.lang.String getContextPath()

ContextPathを取得します。

戻り値:

String ContextPath

getAttribute

public java.lang.Object getAttribute(java.lang.String key)
                              throws AttributeNotFoundException

内包しているHttpServletRequestに設定された属性を取得します。

パラメータ:

key - 属性を取得するキー

戻り値:

Object HttpServletRequest

例外:

AttributeNotFoundException - 指定された属性がnullの場合

getHeader

public java.lang.String getHeader(java.lang.String key)
                           throws AttributeNotFoundException

内包しているHttpServletRequestに設定されたヘッダー情報を取得します。

パラメータ:

key - ヘッダー情報を取得するキー

戻り値:

String HttpServletRequest

例外:

AttributeNotFoundException - 指定された属性がnullの場合

getAttribute

public java.lang.Object getAttribute(java.lang.String key,
                                     boolean allowNull)
                              throws AttributeNotFoundException

内包しているHttpServletRequestに設定された属性を取得します。

パラメータ:

key - 属性を取得するキー

allowNull - trueの場合は戻り値がnullを許します。

戻り値:

Object HttpServletRequest

例外:

AttributeNotFoundException - 指定された属性がnullの場合

getHeader

public java.lang.String getHeader(java.lang.String key,
                                  boolean allowNull)
                           throws AttributeNotFoundException

内包しているHttpServletRequestに設定されたヘッダー情報を取得します。

パラメータ:

key - ヘッダー情報を取得するキー

allowNull - trueの場合は戻り値がnullを許します。

戻り値:

String HttpServletRequest

例外:

AttributeNotFoundException - 指定された属性がnullの場合

parse

public java.lang.String parse()

HttpServletRequestの内容を文字で返します。

戻り値:

String HttpServletRequestの内容

parse

public java.lang.String parse(int type)

HttpServletRequestの内容を文字で返します。

パラメータ:

type - ParameterParser.PARAMETER HttpServletRequestに含まれるパラメータ。
ParameterParser.ATTRIBUTE HttpServletRequestに含まれる属性。
（HttpServletRequest.setAttibute(String key, Object value)で設定された値）
ParameterParser.HEADER HttpServletRequestに含まれるヘッダー情報。

戻り値:

String HttpServletRequestの内容

getParameterNames

public java.util.Iterator getParameterNames()

HttpServletRequestのパラメータ名の一覧を返します。

戻り値:

Iterator パラメータの一覧

getCommand

public RequestCommand getCommand()

このRequestParserを実行したコマンドクラスを取得します。

getCommandName

public java.lang.String getCommandName()

このRequestParserを実行したコマンドクラス名を取得します。

getReqId

public java.lang.String getReqId()

reqidを取得します