パッケージ jakarta.json
インターフェース JsonReader
- すべてのスーパーインターフェース:
AutoCloseableSE,CloseableSE
入力ソースから JSON
object または array 構造を読み取ります。 クラス Json には、入力ソース(InputStreamSE および ReaderSE)からリーダーを作成するためのメソッドが含まれています。
次の例は、空の JSON 配列を文字列から読み取る方法を示しています。
JsonReader jsonReader = Json.createReader(new StringReader("[]"));
JsonArray array = jsonReader.readArray();
jsonReader.close();
クラス JsonReaderFactory には、JsonReader インスタンスを作成するためのメソッドも含まれています。ファクトリインスタンスを使用して、同じ構成で複数のリーダーインスタンスを作成できます。これは、複数のインスタンスを作成するための推奨される方法です。次の例に使用例を示します。
JsonReaderFactory factory = Json.createReaderFactory(config);
JsonReader reader1 = factory.createReader(...);
JsonReader reader2 = factory.createReader(...);
メソッドの詳細
read
JsonStructure read()入力ソースで表される JSON 配列またはオブジェクトを返します。このメソッドは、リーダーインスタンスに対して 1 回だけ呼び出す必要があります。- 戻り値:
- JSON オブジェクトまたは配列
- 例外:
JsonException- I/O エラーのために JSON オブジェクトまたは配列を作成できない場合 (IOException は JsonException の原因となる)JsonParsingException- 正しくない表現のために JSON オブジェクトまたは配列を作成できない場合IllegalStateExceptionSE- 読み取られた場合、readObject、readArray、readValue、close メソッドがすでに呼び出されています
readObject
JsonObject readObject()入力ソースで表される JSON オブジェクトを返します。このメソッドは、リーダーインスタンスに対して 1 回だけ呼び出す必要があります。- 戻り値:
- JSON オブジェクト
- 例外:
JsonException- I/O エラーのために JSON オブジェクトを作成できない場合 (IOException は JsonException の原因となる)JsonParsingException- 表現が正しくないために JSON オブジェクトを作成できない場合IllegalStateExceptionSE- 読み取られた場合、readObject、readArray、readValue、close メソッドがすでに呼び出されています
readArray
JsonArray readArray()入力ソースで表される JSON 配列を返します。このメソッドは、リーダーインスタンスに対して 1 回だけ呼び出す必要があります。- 戻り値:
- JSON 配列
- 例外:
JsonException- I/O エラーのために JSON 配列を作成できない場合 (IOException は JsonException の原因となる)JsonParsingException- 正しくない表現のために JSON 配列を作成できない場合IllegalStateExceptionSE- 読み取られた場合、readObject、readArray、readValue、close メソッドがすでに呼び出されています
readValue
入力ソースで表される JSON 値を返します。このメソッドは、リーダーインスタンスに対して 1 回だけ呼び出す必要があります。- 戻り値:
- JSON 値
- 例外:
JsonException- I/O エラーが原因で JSON 値が作成された場合 (IOException は JsonException の原因となる)JsonParsingException- 不適切な表現のために JSON 値を作成できない場合IllegalStateExceptionSE- 読み取られた場合、readObject、readArray、readValue、close メソッドがすでに呼び出されています- 導入:
- 1.1
close
void close()このリーダーを閉じて、リーダーに関連付けられているすべてのリソースを解放します。このメソッドは、基になる入力ソースを閉じます。- 次で指定:
- インターフェース
AutoCloseableSEのclose - 次で指定:
- インターフェース
CloseableSEのclose - 例外:
JsonException- I/O エラーが発生した場合 (IOException は JsonException の原因となる)