IoItems

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

← クラス一覧に戻る

クラス情報

パッケージ: com.onepg.util

クラス名: IoItems

継承: AbstractIoTypeMap

説明

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

  • CSV を入出力することができる。
  • JSON を入出力することができる。
  • URLパラメーター を入出力することができる。
  • 基本ルール・制限は AbstractIoTypeMap に準拠する。

関連項目

メソッド一覧

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 - ハッシュコード

putAllByBatParam

public int putAllByBatParam(String[] args)
バッチパラメーター値を格納（内容はURLパラメーターと同じ形式）.
  • 既に存在するキーでの格納は実行時エラーとなる。
  • コマンドライン引数1つあたりの長さ制限に対応するため、複数の引数を配列として受け取る。

パラメータ

名前 型 説明
args String[] バッチパラメーター配列（各要素はURLパラメーター形式の文字列）

戻り値

int - 格納パラメーター数

Generated by JavaDocGenerator - 2026