クラス JSONFile

java.lang.Object

io.github.takenoko4096.json.JSONFile

@NullMarked
public class JSONFile
extends Object

json形式のファイルを表現します。

コンストラクタの概要

コンストラクタ

コンストラクタ	説明
JSONFile(File file)	FileからJSONFileを作成します。
JSONFile(String path)	パスを表現するStringからJSONFileを作成します。
JSONFile(Path path)	PathからJSONFileを作成します。

メソッドの概要

修飾子とタイプ	メソッド	説明
void	create()	空のファイルを作成します。
void	delete()	ファイルを削除します。
void	edit(Function<JSONStructure, JSONStructure> function)	jsonファイルの記述を読み取り、任意の関数によって構造を編集して再度書き込みます。
boolean	exists()	ファイルが存在するかどうかを返します。
JSONStructure	read()	json構造としてファイルの記述を読み取ります。
JSONArray	readAsArray()	ルートが配列であることを期待してファイルの記述を読み取ります。
JSONObject	readAsObject()	ルートがオブジェクトであることを期待してファイルの記述を読み取ります。
protected String	readAsString()	ファイルの内容を文字列として読み取り、文字列として返します。
long	size()	ファイルサイズを取得します。
File	toFile()	java.io.Fileとして取得します。
void	write(JSONStructure structure)	json構造をシリアライズして書き込みます。
protected void	writeAsString(String json)	ファイルの内容を引数に渡された文字列で上書きします。

クラスから継承されたメソッド Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

JSONFile

public JSONFile(File file)

FileからJSONFileを作成します。

パラメータ:

file - Fileオブジェクト。

JSONFile

public JSONFile(Path path)

PathからJSONFileを作成します。

パラメータ:

path - Pathオブジェクト。

JSONFile

public JSONFile(String path)

パスを表現するStringからJSONFileを作成します。

パラメータ:

path - パスとなる文字列。Path.of()でパースして使用されます。

メソッドの詳細

toFile

public File toFile()

java.io.Fileとして取得します。

戻り値:

ラップされていたFileオブジェクト。

readAsString

protected String readAsString()
                       throws IllegalStateException

ファイルの内容を文字列として読み取り、文字列として返します。

戻り値:

空白文字・改行を含む文字列。

例外:

IllegalStateException - ファイルが存在しない、またはI/O例外の場合。

writeAsString

protected void writeAsString(String json)
                      throws IllegalStateException

ファイルの内容を引数に渡された文字列で上書きします。

パラメータ:

json - 空白文字・改行を含む文字列。

例外:

IllegalStateException - ファイルが存在しない、またはI/O例外の場合。

exists

public boolean exists()

ファイルが存在するかどうかを返します。

戻り値:

存在する場合に真。

create

public void create()
            throws IllegalStateException

空のファイルを作成します。

例外:

IllegalStateException - 既に存在する、またはI/O例外の場合。

delete

public void delete()
            throws IllegalStateException

ファイルを削除します。

例外:

IllegalStateException - ファイルが存在しない、またはI/O例外の場合。

size

public long size()
          throws IllegalStateException

ファイルサイズを取得します。

戻り値:

ファイルサイズ (bytes)。

例外:

IllegalStateException - ファイルが存在しない、またはI/O例外の場合。

read

public JSONStructure read()
                   throws JSONParseException,
IllegalStateException

json構造としてファイルの記述を読み取ります。

戻り値:

パース結果。

例外:

JSONParseException - パースに失敗した場合。

IllegalStateException - ファイルの読み取りに失敗した場合。

write

public void write(JSONStructure structure)
           throws JSONSerializationException,
IllegalStateException

json構造をシリアライズして書き込みます。

パラメータ:

structure - json構造。

例外:

JSONSerializationException - シリアライズに失敗した場合。

IllegalStateException - ファイルの書き込みに失敗した場合。

readAsObject

public JSONObject readAsObject()
                        throws JSONParseException,
IllegalStateException

ルートがオブジェクトであることを期待してファイルの記述を読み取ります。

戻り値:

jsonオブジェクト。

例外:

JSONParseException - パースに失敗した場合。

IllegalStateException - ファイルの読み取りに失敗した場合。

readAsArray

public JSONArray readAsArray()
                      throws JSONParseException,
IllegalStateException

ルートが配列であることを期待してファイルの記述を読み取ります。

戻り値:

json配列。

例外:

JSONParseException - パースに失敗した場合。

IllegalStateException - ファイルの読み取りに失敗した場合。

edit

public void edit(Function<JSONStructure, JSONStructure> function)
          throws JSONParseException,
JSONSerializationException,
IllegalStateException

jsonファイルの記述を読み取り、任意の関数によって構造を編集して再度書き込みます。

パラメータ:

function - 構造を編集する関数。

例外:

JSONParseException - パースに失敗した場合。

JSONSerializationException - シリアライズに失敗した場合。

IllegalStateException - ファイルの読み取りまたは書き込みに失敗した場合。