起動・前提準備
初期テーブル、依存状態、定期処理の点灯など、このクラスが動き始める前提をまとめています。
主なメソッド
主なフィールド
なし
Class: YamlSidebarPrefs
Yaml Sidebar Prefs を担当するclassです。
3Fields
1Constructors
3Methods
34Lines
- Package
com.example.rankingplugin.sidebar- Source
sidebar/YamlSidebarPrefs.java- Kind
class- Roles
- 自動抽出なし
このクラスにも章立て解説を追加しています。 自動抽出の一覧だけでなく、下の『重点クラスの詳細解説』で読む順番・内部サブシステム・変更時の注意点まで追えます。 全クラス章立てガイドを見る
クラス説明
クラス直前の Javadoc は見つかりませんでした。ソースとメソッド構成から責務を補完しています。
責務と見どころ
- 役割ラベルは自動抽出結果がありませんでした。
重点クラスの詳細解説
Yaml Sidebar Prefs を担当するclassです。sidebar パッケージの 小規模クラスで、責務境界の要点を確認する起点です。全面展開版では、他の重点クラスと同じ章立てで読めるように補強しています。
最初に追う読む順番
YamlSidebarPrefs依存オブジェクトと初期状態を束ね、このクラスが担当するランタイムの前提を固めます。isOn条件判定を行い、後続処理の分岐に使える真偽値を返します。setset の主要処理を担当します。
内部サブシステムの地図
状態反映と永続化
メモリ状態と保存状態を揃え、結果を次の呼び出しや画面表示へ繋ぐ部分です。
主なメソッド
主なフィールド
なし
代表フロー詳解
初期化と起動の流れ
このクラスが前提状態を揃え、外部から利用可能な形まで立ち上がる流れです。新規依存の追加や起動失敗の調査はまずここから追います。
通常運用の中心フロー
イベント受理、判定、状態更新、通知までの主経路です。体感不具合や想定外の分岐はこの流れのどこで止まるかを見ると切り分けやすいです。
反映・保存・終了の流れ
結果を保持し、必要なら永続化し、最後に掃除まで行う出口です。画面更新だけ合って保存が壊れるケースや残骸が残るケースの確認に向きます。
変更時の注意点
- 公開メソッドと内部補助メソッドの責務境界を保つと読みやすさが落ちにくく、後から責務分割しやすくなります。
フィールド
| Visibility | Type | Name | 役割 |
|---|---|---|---|
private | File | file | file の状態を保持します。 |
private | YamlConfiguration | yaml | yaml の状態を保持します。 |
private | Logger | log | log の状態を保持します。 |
コンストラクタ / 初期化
| Signature | 説明 | 主要呼び出し |
|---|---|---|
public YamlSidebarPrefs(File dataFolder, Logger log) | 依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。 | loadConfiguration |
メソッド索引
| Name | Visibility | Kind | 説明 |
|---|---|---|---|
| YamlSidebarPrefs | public | コンストラクタ | 依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。 |
| isOn | public | メソッド | 条件判定を行い、後続処理の分岐に使える真偽値を返します。 |
| set | public | メソッド | set の主要処理を担当します。 |
メソッド詳細
YamlSidebarPrefs
public YamlSidebarPrefs(File dataFolder, Logger log)依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。
引数
File dataFolderLogger log
throws
なし
主要な呼び出し順
loadConfiguration
isOn
public boolean isOn(UUID uuid)条件判定を行い、後続処理の分岐に使える真偽値を返します。
引数
UUID uuid
throws
なし
主要な呼び出し順
getBooleantoString
set
public void set(UUID uuid, boolean on)set の主要処理を担当します。
引数
UUID uuidboolean on
throws
なし
主要な呼び出し順
toStringsavewarninggetMessage
代表的な処理フロー
- 初期化フロー
YamlSidebarPrefs → loadConfiguration依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。 - set フロー
set → toString → save → warning → getMessageset の主要処理を担当します。 - isOn フロー
isOn → getBoolean → toString条件判定を行い、後続処理の分岐に使える真偽値を返します。
外部との接点
Web ルート
このクラス内に目立つ Web ルート定義は見つかりませんでした。
SQL / テーブル
テーブル名の抽出はありませんでした。
関連クラス
- 関連クラスは抽出されませんでした。
補足
- メソッド説明と処理フローは、Javadoc とソース本体の呼び出し列から自動要約しています。
- 匿名クラスや複雑なラムダ初期化を多用する箇所では、一部のフィールド / 呼び出し順が簡略表示になる場合があります。