Io

フレームワーク部品 [com.onepg.util]

← クラス一覧に戻る

クラス情報

パッケージ: com.onepg.util

クラス名: Io

継承: AbstractIoTypeMap

説明

入出力マップクラス.
  • 型ごとの値取得メソッドと値格納メソッドを持つマップクラス。
  • 内部的には文字列で値を保持する。
  • 値の格納順序を保持する。
  • Map<String, String> を継承することで汎用性を持たせている。
  • コンストラクタの引数指定で読み取り専用にできる。
  • 基本ルール・制限
    • キーとして使用できる文字は英字小文字と数字、アンダースコア、ハイフン、ドットのみに限定される。
      （JSON で使用可能な文字のみ、かつ DBMS差異をなくすため英字は小文字統一とする）
    • 原則として値取得メソッドは null を返さない。
    • null を取得したい場合は意図的なメソッド［例］#getStringNullable(String) で取得する。
    • 原則として存在しないキーでの値取得は実行時エラーとなる。
    • 存在しない可能性があるキーで値取得する場合は #containsKey(Object) にて事前に存在確認するか、 非存在時の戻値を指定する意図的なメソッド［例］#getStringOrDefault(String, String) で取得する。
    • 既に存在するキーでの格納は実行時エラーとなる。
    • 既に存在する可能性があるキーで値を格納する場合は意図的なメソッド［例］#putForce(String, String) で格納する。
    • null を明示的に格納したい場合も意図的なメソッド［例］#putNull(String) で格納する。
    • 通常のマップとは異なり #keySet()、#entrySet()、#values() の結果は読取専用となっている。
      （内部でキーを別管理しており、結果から削除されると整合性が崩れるため）
    • タイムスタンプは小数６桁までで保持される。

  • 文字列リストを保持することができる。
  • ネストされた可変型マップを保持することができる。
  • 複数行の可変型マップをリストで保持することができる。
  • 文字列配列（リスト）をリストで保持することができる。
  • 上記のデータ構造は格納時・取得時ともにディープコピーされる。
  • サーバーとWebページ間で共有するセッションデータを保持することができる。
  • Webページへの表示用メッセージを保持することができる。
  • JSON を入出力することができる。
  • URLパラメーター を入出力することができる。
  • 基本ルール・制限は AbstractIoTypeMap に準拠する。
  • 文字列リストについて
    • #getList(String)、#putList(String, List)、#containsKeyList(String)、 #removeList(String) などの **Listメソッドから扱う。
    • マップクラスが持つ #size() や #containsKey(Object)、 #keySet() などの結果に文字列リストは含まれない。
      ただし #clear() では文字列リストの保持もクリアされる。
    • #getList(String) から取得したリストに要素を追加しても本クラスで保持しているリストに影響しない。
    • #putList(String, List) で格納した元のリストに要素を追加しても本クラスで保持しているリストに影響しない。
    • 文字列リストは CSV 出力の対象にはならない。
    • 文字列リストを含む URLパラメーター は文字列長さに注意する。
    • ディープコピーを行うため、リストの格納・取得を繰り返す処理や、サイズの大きいリストを扱う処理では性能が低下する可能性がある。
  • ネストマップについて
    • #getNest(String)、#putNest(String, Map)、#containsKeyNest(String)、 #removeNest(String) などの **Nestメソッドから扱う。
    • マップクラスが持つ #size() や #containsKey(Object)、 #keySet() などの結果にネストマップは含まれない。
      ただし #clear() ではネストマップの保持もクリアされる。
    • #getNest(String) から取得したマップに要素を追加しても本クラスで保持しているマップに影響しない。
    • #putNest(String, List) で格納した元のマップに要素を追加しても本クラスで保持しているマップに影響しない。
    • ネストマップは CSV 出力、URLパラメーター出力の対象にはならない。
    • ディープコピーを行うため、リストの格納・取得を繰り返す処理や、サイズの大きいリストを扱う処理では性能が低下する可能性がある。
  • 複数行リストについて
    • #getRows(String)、#putRows(String, Collection)、 #containsKeyRows(String)、#removeRows(List) などの **Rowsメソッドから扱う。
    • マップクラスが持つ #size() や #containsKey(Object)、 #keySet() などの結果に複数行リストは含まれない。
      ただし #clear() では複数行リストの保持もクリアされる。
    • #getRows(String) から取得したリストに要素を追加しても本クラスで保持しているリストに影響しない。
    • #putRows(String, Collection) で格納した元のリストに要素を追加しても本クラスで保持しているリストに影響しない。
    • 複数行リストは CSV 出力、URLパラメーター出力の対象にはならない。
    • ディープコピーを行うため、リストの格納・取得を繰り返す処理や、サイズの大きいリストを扱う処理では性能が低下する可能性がある。
  • 配列リストについて
    • #getArys(String)、#putArys(String, Collection)、 #containsKeyArys(String)、#removeArys(List) などの **Arysメソッドから扱う。
    • マップクラスが持つ #size() や #containsKey(Object)、 #keySet() などの結果に配列リストは含まれない。
      ただし #clear() では配列リストの保持もクリアされる。
    • #getArys(String) から取得したリストに要素を追加しても本クラスで保持しているリストに影響しない。
    • #putArys(String, Collection) で格納した元のリストに要素を追加しても本クラスで保持しているリストに影響しない。
    • 配列リストは CSV 出力、URLパラメーター出力の対象にはならない。
    • ディープコピーを行うため、リストの格納・取得を繰り返す処理や、サイズの大きいリストを扱う処理では性能が低下する可能性がある。
  • JSON で４階層（次元）以上の配列には対応しない。
    • { [ [ ] ] } は対応。→配列リスト
    • { [ { } ] } は対応。→複数行リスト
    • { [ [ [ ] ] ] } は非対応。
    • { [ [ { } ] ] } は非対応。
  • セッションデータについて
    • セッションデータへの操作は本インスタンスが保持するデータに直接影響する。
    • JSON 取込時にセッションデータも格納される。
    • JSON 作成時にセッションデータも出力される。
    • JSON 入出力時のキーは _session 固定となる。
  • メッセージについて
    • メッセージIDと対象項目名等を保持することができ、JSON 作成時にメッセージも出力される。
    • JSON 作成時のキーは _msg 固定となる。エラーフラグは _has_err 固定となる。
    • JSON 作成時にメッセージテキスト（文言定義）を引数として渡すことで、保持しているメッセージIDに対応する文言も合わせて出力される。
    • メッセージテキスト内の {0}, {1}, ... はメッセージ追加時の引数で渡された文字列で置換される。

関連項目

列挙型一覧

MsgType

public enum MsgType
メッセージタイプ.

定数

  • ERROR
  • WARN
  • INFO

メソッド一覧

getString （継承メソッド）

public String getString(String key)
文字列取得.
  • 存在しないキーでの値取得は実行時エラーとなる。
  • 存在しない可能性があるキーで値取得する場合は #containsKey(Object) にて事前に存在確認する。
  • 格納されている値が null の場合はゼロバイト文字を返す。（null は返らない）
  • null を取得したい場合は #getStringNullable(String) で取得する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

String - 文字列

getStringOrDefault （継承メソッド）

public String getStringOrDefault(String key, String notExistsValue)
文字列取得.
  • 存在しないキーの場合は引数の非存在時戻値が返される。
  • 格納されている値が null の場合はゼロバイト文字を返す。（null は返らない）
  • null を取得したい場合は #getStringNullableOrDefault(String, String) で取得する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
notExistsValue String 非存在時戻値

戻り値

String - 文字列

getStringNullable （継承メソッド）

public String getStringNullable(String key)
文字列取得（null 有り）.
  • 存在しないキーでの値取得は実行時エラーとなる。
  • 存在しない可能性があるキーで値取得する場合は #containsKey(Object) にて事前に存在確認する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

String - 文字列（null 有り）

getStringNullableOrDefault （継承メソッド）

public String getStringNullableOrDefault(String key, String notExistsValue)
文字列取得（null 有り）.
  • 存在しないキーの場合は引数の非存在時戻値が返される。

パラメータ

名前 型 説明
key String キー
notExistsValue String 非存在時戻値

戻り値

String - 文字列（null 有り）

getBigDecimal （継承メソッド）

public BigDecimal getBigDecimal(String key)
数値取得.
  • 存在しないキーでの値取得は実行時エラーとなる。
  • 存在しない可能性があるキーで値取得する場合は #containsKey(Object) にて事前に存在確認する。
  • 格納されている値が null の場合はゼロを返す。（null は返らない）
  • null を取得したい場合は #getBigDecimalNullable(String) で取得する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

BigDecimal - 数値

getBigDecimalOrDefault （継承メソッド）

public BigDecimal getBigDecimalOrDefault(String key, BigDecimal notExistsValue)
数値取得.
  • 存在しないキーの場合は引数の非存在時戻値が返される。
  • 格納されている値が null の場合はゼロを返す。（null は返らない）
  • null を取得したい場合は #getBigDecimalNullableOrDefault(String) で取得する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
notExistsValue BigDecimal 非存在時戻値

戻り値

BigDecimal - 数値

getBigDecimalNullable （継承メソッド）

public BigDecimal getBigDecimalNullable(String key)
数値取得（null 有り）.
  • 存在しないキーでの値取得は実行時エラーとなる。
  • 存在しない可能性があるキーで値取得する場合は #containsKey(Object) にて事前に存在確認する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

BigDecimal - 数値（null 有り）

getBigDecimalNullableOrDefault （継承メソッド）

public BigDecimal getBigDecimalNullableOrDefault(String key, BigDecimal notExistsValue)
数値取得（null 有り）.
  • 存在しないキーの場合は引数の非存在時戻値が返される。

パラメータ

名前 型 説明
key String キー
notExistsValue BigDecimal 非存在時戻値

戻り値

BigDecimal - 数値（null 有り）

getInt （継承メソッド）

public int getInt(String key)
int 値取得.
  • 存在しないキーでの値取得は実行時エラーとなる。
  • 存在しない可能性があるキーで値取得する場合は #containsKey(Object) にて事前に存在確認する。
  • 格納されている値が null の場合はゼロを返す。
  • int 値許容範囲外の場合、例外エラーを投げる。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

int - int 値

getIntOrDefault （継承メソッド）

public int getIntOrDefault(String key, int notExistsValue)
int 値取得.
  • 存在しないキーの場合は引数の非存在時戻値が返される。
  • 格納されている値が null の場合はゼロを返す。
  • int 値許容範囲外の場合、例外エラーを投げる。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
notExistsValue int 非存在時戻値

戻り値

int - int 値

getLong （継承メソッド）

public long getLong(String key)
long 値取得.
  • 存在しないキーでの値取得は実行時エラーとなる。
  • 存在しない可能性があるキーで値取得する場合は #containsKey(Object) にて事前に存在確認する。
  • 格納されている値が null の場合はゼロを返す。
  • long 値許容範囲外の場合、例外エラーを投げる。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

long - long 値

getLongOrDefault （継承メソッド）

public long getLongOrDefault(String key, long notExistsValue)
long 値取得.
  • 存在しないキーの場合は引数の非存在時戻値が返される。
  • 格納されている値が null の場合はゼロを返す。
  • long 値許容範囲外の場合、例外エラーを投げる。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
notExistsValue long 非存在時戻値

戻り値

long - long 値

getDateNullable （継承メソッド）

public LocalDate getDateNullable(String key)
日付取得（null 有り）.
  • 存在しないキーでの値取得は実行時エラーとなる。
  • 存在しない可能性があるキーで値取得する場合は #containsKey(Object) にて事前に存在確認する。
  • 日付変換できない場合、例外エラーを投げる。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

LocalDate - 日付（null 有り）

getDateNullableOrDefault （継承メソッド）

public LocalDate getDateNullableOrDefault(String key, LocalDate notExistsValue)
日付取得（null 有り）.
  • 存在しないキーの場合は引数の非存在時戻値が返される。
  • 日付変換できない場合、例外エラーを投げる。

パラメータ

名前 型 説明
key String キー
notExistsValue LocalDate 非存在時戻値

戻り値

LocalDate - 日付（null 有り）

getDateTimeNullable （継承メソッド）

public LocalDateTime getDateTimeNullable(String key)
日時取得（null 有り）.
  • 存在しないキーでの値取得は実行時エラーとなる。
  • 存在しない可能性があるキーで値取得する場合は #containsKey(Object) にて事前に存在確認する。
  • 日時変換できない場合、例外エラーを投げる。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

LocalDateTime - 日時（null 有り）

getDateTimeNullableOrDefault （継承メソッド）

public LocalDateTime getDateTimeNullableOrDefault(String key, LocalDateTime notExistsValue)
日時取得（null 有り）.
  • 存在しないキーの場合は引数の非存在時戻値が返される。
  • 日時変換できない場合、例外エラーを投げる。

パラメータ

名前 型 説明
key String キー
notExistsValue LocalDateTime 非存在時戻値

戻り値

LocalDateTime - 日時（null 有り）

getBoolean （継承メソッド）

public boolean getBoolean(String key)
真偽値取得.
  • 存在しないキーでの値取得は実行時エラーとなる。
  • 存在しない可能性があるキーで値取得する場合は #containsKey(Object) にて事前に存在確認する。
  • 真偽値の評価は ValUtil.isTrue(String) に準拠する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

boolean - 真偽値

関連項目

getBooleanOrDefault （継承メソッド）

public boolean getBooleanOrDefault(String key, boolean notExistsValue)
真偽値取得.
  • 存在しないキーの場合は引数の非存在時戻値が返される。
  • 値の評価は ValUtil.isTrue(String) に準拠する。

パラメータ

名前 型 説明
key String キー
notExistsValue boolean 非存在時戻値

戻り値

boolean - 真偽値

putNull （継承メソッド）

public String putNull(String key)
null 格納.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

String - 前回の格納文字列

putNullForce （継承メソッド）

public String putNullForce(String key)
null 格納（上書き許可）.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

String - 前回の格納文字列

put （継承メソッド）

public String put(String key, String value)
文字列格納.
  • 既に存在するキーでの格納は実行時エラーとなる。
  • 既に存在する可能性があるキーで値格納する場合は #putForce(String, String) で格納する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value String 値

戻り値

String - 前回の格納文字列

put （継承メソッド）

public String put(String key, BigDecimal value)
数値格納.
  • 既に存在するキーでの格納は実行時エラーとなる。
  • 既に存在する可能性があるキーで値格納する場合は #putForce(String, BigDecimal) で格納する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value BigDecimal 数値

戻り値

String - 前回の格納文字列

put （継承メソッド）

public String put(String key, int value)
int 値格納.
  • 既に存在するキーでの格納は実行時エラーとなる。
  • 既に存在する可能性があるキーで値格納する場合は #putForce(String, int) で格納する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value int int 値

戻り値

String - 前回の格納文字列

put （継承メソッド）

public String put(String key, long value)
long 値格納.
  • 既に存在するキーでの格納は実行時エラーとなる。
  • 既に存在する可能性があるキーで値格納する場合は #putForce(String, long) で格納する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value long long 値

戻り値

String - 前回の格納文字列

put （継承メソッド）

public String put(String key, LocalDate value)
日付格納.
  • 既に存在するキーでの格納は実行時エラーとなる。
  • 既に存在する可能性があるキーで値格納する場合は #putForce(String, LocalDate) で格納する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value LocalDate 日付

戻り値

String - 前回の格納文字列

put （継承メソッド）

public String put(String key, LocalDateTime value)
日時格納.
  • 既に存在するキーでの格納は実行時エラーとなる。
  • 既に存在する可能性があるキーで値格納する場合は #putForce(String, LocalDateTime) で格納する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value LocalDateTime 日時

戻り値

String - 前回の格納文字列

put （継承メソッド）

public String put(String key, java.util.Date value)
UTIL日付格納.
  • 既に存在するキーでの格納は実行時エラーとなる。
  • 既に存在する可能性があるキーで値格納する場合は #putForce(String, java.util.Date) で格納する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value java.util.Date 日付（java.sql.Date 含む）

戻り値

String - 前回の格納文字列

put （継承メソッド）

public String put(String key, java.sql.Timestamp value)
SQLタイムスタンプ格納.
  • 既に存在するキーでの格納は実行時エラーとなる。
  • 既に存在する可能性があるキーで値格納する場合は #putForce(String, java.sql.Timestamp) で格納する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value java.sql.Timestamp タイムスタンプ

戻り値

String - 前回の格納文字列

put （継承メソッド）

public String put(String key, boolean value)
真偽値格納.
  • 既に存在するキーでの格納は実行時エラーとなる。
  • 既に存在する可能性があるキーで値格納する場合は #putForce(String, boolean) で格納する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value boolean 真偽値

戻り値

String - 前回の格納文字列

putForce （継承メソッド）

public String putForce(String key, String value)
文字列格納（上書き許可）.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value String 値

戻り値

String - 前回の格納文字列

putForce （継承メソッド）

public String putForce(String key, BigDecimal value)
数値格納（上書き許可）.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value BigDecimal 数値

戻り値

String - 前回の格納文字列

putForce （継承メソッド）

public String putForce(String key, int value)
int 値格納（上書き許可）.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value int int 値

戻り値

String - 前回の格納文字列

putForce （継承メソッド）

public String putForce(String key, long value)
long 値格納（上書き許可）.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value long long 値

戻り値

String - 前回の格納文字列

putForce （継承メソッド）

public String putForce(String key, LocalDate value)
日付格納（上書き許可）.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value LocalDate 日付

戻り値

String - 前回の格納文字列

putForce （継承メソッド）

public String putForce(String key, LocalDateTime value)
日時格納（上書き許可）.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value LocalDateTime 日時

戻り値

String - 前回の格納文字列

putForce （継承メソッド）

public String putForce(String key, java.util.Date value)
UTIL日付格納（上書き許可）.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value java.util.Date 日付（java.sql.Date 含む）

戻り値

String - 前回の格納文字列

putForce （継承メソッド）

public String putForce(String key, java.sql.Timestamp value)
SQLタイムスタンプ格納（上書き許可）.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value java.sql.Timestamp タイムスタンプ

戻り値

String - 前回の格納文字列

putForce （継承メソッド）

public String putForce(String key, boolean value)
真偽値格納（上書き許可）.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
value boolean 真偽値

戻り値

String - 前回の格納文字列

putAll （継承メソッド）

public void putAll(Map<? extends String, ? extends String> map)
全値格納.
  • 既に存在するキーでの格納は実行時エラーとなる。
  • 既に存在する可能性があるキーが含まれる場合は #putAllForce(Map) で格納する。

パラメータ

名前 型 説明
map Map<? extends String, ? extends String> マップ

putAllForce （継承メソッド）

public void putAllForce(Map<? extends String, ? extends String> map)
全値格納（上書き許可）.

パラメータ

名前 型 説明
map Map<? extends String, ? extends String> マップ

size （継承メソッド）

public int size()
マップサイズ取得.

戻り値

int - マップサイズ

isEmpty （継承メソッド）

public boolean isEmpty()
マップゼロ件判断.

戻り値

boolean - ゼロ件の場合は true

containsKey （継承メソッド）

public boolean containsKey(Object key)
マップキー存在確認.

パラメータ

名前 型 説明
key Object キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

boolean - 存在する場合は true

containsValue （継承メソッド）

public boolean containsValue(Object value)
マップ値存在確認.

パラメータ

名前 型 説明
value Object 値

戻り値

boolean - 存在する場合は true

remove （継承メソッド）

public String remove(Object key)
マップ値削除.

パラメータ

名前 型 説明
key Object キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

String - 削除された値

clear （継承メソッド）

public void clear()
クリア.
  • 容易なインスタンスの使いまわしを防ぐためクリアメソッドを禁止している。
  • クリアの代わりに新しいインスタンスを作成してください。

keySet （継承メソッド）

public Set<String> keySet()
キーセット取得.
  • 削除されると内部の整合性が崩れるため読取専用としている。

戻り値

Set<String> - キーセット

values （継承メソッド）

public Collection<String> values()
値セット取得.
  • 削除されると内部の整合性が崩れるため読取専用としている。

戻り値

Collection<String> - 値セット

entrySet （継承メソッド）

public Set<Entry<String, String>> entrySet()
エントリーセット取得.
  • 削除されると内部の整合性が崩れるため読取専用としている。

戻り値

Set<Entry<String, String>> - エントリーセット

equals （継承メソッド）

public boolean equals(Object obj)
イコール比較.
  • 同一内容であればイコールと判断する。

パラメータ

名前 型 説明
obj Object 比較オブジェクト

戻り値

boolean - 同一内容の場合は true

hashCode （継承メソッド）

public int hashCode()
ハッシュコード取得.

戻り値

int - ハッシュコード

session

public AbstractIoTypeMap session()
セッションデータ参照.
  • ディープコピーせず参照を返すため、戻り値への操作は本インスタンスが保持するセッションデータに直接影響する。

戻り値

AbstractIoTypeMap - セッションデータ（参照）

getList

public List<String> getList(String key)
文字列リスト取得.
  • 存在しないキーでの値取得は実行時エラーとなる。
  • 存在しない可能性があるキーで値取得する場合は #containsKeyList(String) にて事前に存在確認する。
  • 格納されている値が null の場合はサイズゼロのリストを返す。（null は返らない）
  • 取得したリストに要素を追加しても本クラスで保持しているリストに影響しない。（ディープコピーとなる）
  • サイズが大きいリストを扱ったり、リストの格納と取得を繰り返したりすると性能が悪化する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

List<String> - 文字列リスト

putList

public List<String> putList(String key, List<String> list)
文字列リスト格納.
  • 既に存在するキーでの格納は実行時エラーとなる。
  • 既に存在する可能性があるキーで値格納する場合は #putListForce(String, List) で格納する。
  • 格納した元のリストに要素を追加しても本クラスで保持しているリストに影響しない。（ディープコピーとなる）
  • サイズが大きいリストを扱ったり、リストの格納と取得を繰り返したりすると性能が悪化する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
list List<String> 文字列リスト

戻り値

List<String> - 前回の格納文字列リスト

putListForce

public List<String> putListForce(String key, List<String> list)
文字列リスト格納（上書き許可）.
  • 格納した元のリストに要素を追加しても本クラスで保持しているリストに影響しない。（ディープコピーとなる）
  • サイズが大きいリストを扱ったり、リストの格納と取得を繰り返したりすると性能が悪化する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
list List<String> 文字列リスト

戻り値

List<String> - 前回の格納文字列リスト

getNest

public Io getNest(String key)
ネストマップ取得.
  • 存在しないキーでの値取得は実行時エラーとなる。
  • 存在しない可能性があるキーで値取得する場合は #containsKeyNest(String) にて事前に存在確認する。
  • 格納されている値が null の場合はサイズゼロのマップを返す。（null は返らない）
  • 取得したマップに要素を追加しても本クラスで保持しているマップに影響しない。（ディープコピーとなる）
  • サイズが大きいマップを扱ったり、マップの格納と取得を繰り返したりすると性能が悪化する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

Io - ネストマップ

putNest

public Io putNest(String key, Io nest)
ネストマップ格納.
  • 既に存在するキーでの格納は実行時エラーとなる。
  • 既に存在する可能性があるキーで値格納する場合は #putNestForce(String, Nest) で格納する。
  • 格納した元のマップに要素を追加しても本クラスで保持しているマップに影響しない。（ディープコピーとなる）
  • サイズが大きいマップを扱ったり、マップの格納と取得を繰り返したりすると性能が悪化する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
nest Io ネストマップ

戻り値

Io - 前回の格納ネストマップ

putNestForce

public Io putNestForce(String key, Io nest)
ネストマップ格納（上書き許可）.
  • 格納した元のマップに要素を追加しても本クラスで保持しているマップに影響しない。（ディープコピーとなる）
  • サイズが大きいマップを扱ったり、マップの格納と取得を繰り返したりすると性能が悪化する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
nest Io ネストマップ

戻り値

Io - 前回の格納ネストマップ

関連項目

getRows

public IoRows getRows(String key)
複数行リスト取得.
  • 存在しないキーでの値取得は実行時エラーとなる。
  • 存在しない可能性があるキーで値取得する場合は #containsKeyRows(String) にて事前に存在確認する。
  • 格納されている値が null の場合はサイズゼロのリストを返す。（null は返らない）
  • 取得したリストに要素を追加しても本クラスで保持しているリストに影響しない。（ディープコピーとなる）
  • サイズが大きいリストを扱ったり、リストの格納と取得を繰り返したりすると性能が悪化する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

IoRows - 複数行リスト

putRows

public IoRows putRows(String key, Collection<? extends Map<? extends String, ? extends String>> rows)
複数行リスト格納.
  • 既に存在するキーでの格納は実行時エラーとなる。
  • 既に存在する可能性があるキーで値格納する場合は #putRowsForce(String, List) で格納する。
  • 格納した元のリストに要素を追加しても本クラスで保持しているリストに影響しない。（ディープコピーとなる）
  • サイズが大きいリストを扱ったり、リストの格納と取得を繰り返したりすると性能が悪化する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
rows Collection<? extends Map<? extends String, ? extends String>> 複数行リスト

戻り値

IoRows - 前回の格納複数行リスト

putRowsForce

public IoRows putRowsForce(String key, Collection<? extends IoItems> rows)
複数行リスト格納（上書き許可）.
  • 格納した元のリストに要素を追加しても本クラスで保持しているリストに影響しない。（ディープコピーとなる）
  • サイズが大きいリストを扱ったり、リストの格納と取得を繰り返したりすると性能が悪化する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
rows Collection<? extends IoItems> 複数行リスト

戻り値

IoRows - 前回の格納複数行リスト

getArys

public IoArrays getArys(String key)
配列リスト取得.
  • 存在しないキーでの値取得は実行時エラーとなる。
  • 存在しない可能性があるキーで値取得する場合は #containsKeyArys(String) にて事前に存在確認する。
  • 格納されている値が null の場合はサイズゼロのリストを返す。（null は返らない）
  • 取得したリストに要素を追加しても本クラスで保持しているリストに影響しない。（ディープコピーとなる）
  • サイズが大きいリストを扱ったり、リストの格納と取得を繰り返したりすると性能が悪化する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

IoArrays - 配列リスト

putArys

public IoArrays putArys(String key, Collection<? extends List<String>> arys)
配列リスト格納.
  • 既に存在するキーでの格納は実行時エラーとなる。
  • 既に存在する可能性があるキーで値格納する場合は #putArysForce(String, List) で格納する。
  • 格納した元のリストに要素を追加しても本クラスで保持しているリストに影響しない。（ディープコピーとなる）
  • サイズが大きいリストを扱ったり、リストの格納と取得を繰り返したりすると性能が悪化する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
arys Collection<? extends List<String>> 配列リスト

戻り値

IoArrays - 前回の格納配列リスト

putArysForce

public IoArrays putArysForce(String key, Collection<? extends List<String>> arys)
配列リスト格納（上書き許可）.
  • 格納した元のリストに要素を追加しても本クラスで保持しているリストに影響しない。（ディープコピーとなる）
  • サイズが大きいリストを扱ったり、リストの格納と取得を繰り返したりすると性能が悪化する。

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）
arys Collection<? extends List<String>> 配列リスト

戻り値

IoArrays - 前回の格納配列リスト

createJson

public String createJson()
JSON作成.

戻り値

String - JSON文字列

createJsonWithMsg

public String createJsonWithMsg(Map<String, String> msgTextMap)
メッセージ付き JSON作成.

パラメータ

名前 型 説明
msgTextMap Map<String, String> メッセージテキストマップ<メッセージID、メッセージテキスト>

戻り値

String - JSON文字列

putAll

public void putAll(Io map)
全値格納.
  • 既に存在するキーでの格納は実行時エラーとなる。
  • 既に存在する可能性があるキーが含まれる場合は #putAllForce(Map) で格納する。
  • メッセージもコピーされる。

パラメータ

名前 型 説明
map Io 入出力マップ

putAllForce

public void putAllForce(Io map)
全値格納（上書き許可）.

パラメータ

名前 型 説明
map Io 入出力マップ

関連項目

putAllByUrlParam

public int putAllByUrlParam(String url)
URLパラメーター（URLの?より後ろの部分）値格納.
  • 既に存在するキーでの格納は実行時エラーとなる。

パラメータ

名前 型 説明
url String URL全体 または URLパラメーター

戻り値

int - 格納パラメーター数

putAllByJson

public int putAllByJson(String json)
JSON格納.

パラメータ

名前 型 説明
json String JSON文字列

戻り値

int - 格納項目数

containsKeyList

public boolean containsKeyList(String key)
文字列リストキー存在確認.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

boolean - 存在する場合は true

removeList

public List<String> removeList(String key)
文字列リスト削除.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

List<String> - 削除したリスト

containsKeyNest

public boolean containsKeyNest(String key)
ネストマップキー存在確認.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

boolean - 存在する場合は true

removeNest

public Io removeNest(String key)
ネストマップ削除.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

Io - 削除したネストマップ

containsKeyRows

public boolean containsKeyRows(String key)
複数行リストキー存在確認.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

boolean - 存在する場合は true

removeRows

public IoRows removeRows(String key)
複数行リスト削除.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

IoRows - 削除した複数行リスト

containsKeyArys

public boolean containsKeyArys(String key)
配列リストキー存在確認.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

boolean - 存在する場合は true

removeArys

public IoArrays removeArys(String key)
配列リスト削除.

パラメータ

名前 型 説明
key String キー（英字小文字、数字、アンダースコア、ハイフン、ドットのみ）

戻り値

IoArrays - 削除した配列リスト

putMsg

public void putMsg(MsgType type, String msgId)
メッセージ追加.

パラメータ

名前 型 説明
type MsgType メッセージタイプ
msgId String メッセージID

putMsg

public void putMsg(MsgType type, String msgId, String[] replaceVals)
メッセージ追加.

パラメータ

名前 型 説明
type MsgType メッセージタイプ
msgId String メッセージID
replaceVals String[] メッセージ内置換文字列（省略可能）

putMsg

public void putMsg(MsgType type, String msgId, String itemId)
メッセージ追加.

パラメータ

名前 型 説明
type MsgType メッセージタイプ
msgId String メッセージID
itemId String 対象項目ID（省略可能）

putMsg

public void putMsg(MsgType type, String msgId, String[] replaceVals, String itemId)
メッセージ追加.

パラメータ

名前 型 説明
type MsgType メッセージタイプ
msgId String メッセージID
replaceVals String[] メッセージ内置換文字列（省略可能）
itemId String 対象項目ID（省略可能）

putMsg

public void putMsg(MsgType type, String msgId, String itemId, String rowListId, int rowIndex)
メッセージ追加.

パラメータ

名前 型 説明
type MsgType メッセージタイプ
msgId String メッセージID
itemId String 対象項目ID（省略可能）
rowListId String 行リストID（省略可能）
rowIndex int 行インデックス（省略可能）

putMsg

public void putMsg(MsgType type, String msgId, String[] replaceVals, String itemId, String rowListId, int rowIndex)
メッセージ追加.

パラメータ

名前 型 説明
type MsgType メッセージタイプ
msgId String メッセージID
replaceVals String[] メッセージ内置換文字列（省略可能）
itemId String 対象項目ID（省略可能）
rowListId String 行リストID（省略可能）
rowIndex int 行インデックス（省略可能）

hasMsg

public boolean hasMsg()
メッセージ保持判定.

戻り値

boolean - メッセージが保持されている場合は true

hasErrorMsg

public boolean hasErrorMsg()
エラーメッセージ存在判定.

戻り値

boolean - エラーメッセージが存在する場合は true

clearMsg

public void clearMsg()
メッセージクリア.

Generated by JavaDocGenerator - 2026