起動・前提準備
初期テーブル、依存状態、定期処理の点灯など、このクラスが動き始める前提をまとめています。
主なメソッド
主なフィールド
Class: DiscordNotifier
Discord Notifier を担当するclassです。
9Fields
1Constructors
11Methods
363Lines
- Package
com.example.rankingplugin.discord- Source
discord/DiscordNotifier.java- Kind
class- Roles
- 初期化 / ブートストラップ
このクラスにも章立て解説を追加しています。 自動抽出の一覧だけでなく、下の『重点クラスの詳細解説』で読む順番・内部サブシステム・変更時の注意点まで追えます。 全クラス章立てガイドを見る
クラス説明
クラス直前の Javadoc は見つかりませんでした。ソースとメソッド構成から責務を補完しています。
責務と見どころ
- 初期化 / ブートストラップ — 他コンポーネントを組み立て、起動時の全体配線を担います。
重点クラスの詳細解説
Discord Notifier を担当するclassです。discord パッケージの中でも 363 行規模の中核クラスで、Web 導線が一か所に集まっています。中規模クラス群の中では変更影響が広く、章立てで読む価値が高いため重点解説へ追加しています。
最初に追う読む順番
DiscordNotifier依存オブジェクトと初期状態を束ね、このクラスが担当するランタイムの前提を固めます。create実体や対象状態を作る段階で、後続フローがどのデータを前提に動くかを掴めます。shutdownGracefully後片付けと停止の出口です。残骸や再ログイン後の不整合はここを確認します。shutdown後片付けと停止の出口です。残骸や再ログイン後の不整合はここを確認します。getJdaRankingPlugin 側で追加リスナー登録などを行うために公開。notifyBootWithEventsnotifyBootWithEvents の主要処理を担当します。allowallow の主要処理を担当します。notifyGenericnotifyGeneric の主要処理を担当します。safesafe の主要処理を担当します。
内部サブシステムの地図
入口 API と対象解決
外部から呼ばれる公開メソッドや、対象プレイヤー・対象データ・対象ワールドを引き当てる経路です。
主なフィールド
状態反映と永続化
メモリ状態と保存状態を揃え、結果を次の呼び出しや画面表示へ繋ぐ部分です。
主なフィールド
終了処理と掃除
停止時やフロー終端で残る実体・タスク・キャッシュを戻す出口です。
主なメソッド
主なフィールド
なし
代表フロー詳解
初期化と起動の流れ
このクラスが前提状態を揃え、外部から利用可能な形まで立ち上がる流れです。新規依存の追加や起動失敗の調査はまずここから追います。
通常運用の中心フロー
イベント受理、判定、状態更新、通知までの主経路です。体感不具合や想定外の分岐はこの流れのどこで止まるかを見ると切り分けやすいです。
反映・保存・終了の流れ
結果を保持し、必要なら永続化し、最後に掃除まで行う出口です。画面更新だけ合って保存が壊れるケースや残骸が残るケースの確認に向きます。
変更時の注意点
- Web 入口を増やすときは、認証・権限・レスポンス形式・キャッシュ更新を一緒に設計すると後戻りが減ります。
フィールド
コンストラクタ / 初期化
| Signature | 説明 | 主要呼び出し |
|---|---|---|
private DiscordNotifier(JavaPlugin plugin, JDA jda, String channelId, boolean onBoot, boolean onPreStart, boolean onCreated, boolean onStarted, boolean onEnded, boolean includeRewards, ConfigurationSection perType) | 依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。 | 主要呼び出しなし |
メソッド索引
| Name | Visibility | Kind | 説明 |
|---|---|---|---|
| DiscordNotifier | private | コンストラクタ | 依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。 |
| create | public | メソッド | create の主要処理を担当します。 |
| getJda | public | メソッド | RankingPlugin 側で追加リスナー登録などを行うために公開。 |
| notifyBootWithEvents | public | メソッド | notifyBootWithEvents の主要処理を担当します。 |
| allow | private | メソッド | allow の主要処理を担当します。 |
| notifyGeneric | public | メソッド | notifyGeneric の主要処理を担当します。 |
| safe | private | メソッド | safe の主要処理を担当します。 |
| notifyShutdown | public | メソッド | notifyShutdown の主要処理を担当します。 |
| notifyShutdownSync | public | メソッド | 停止時に確実に届けたい場合のブロッキング版（タイムアウト付き） |
| shutdownGracefully | public | メソッド | 動作中の処理やリソースを安全に停止・解放します。 |
| shutdown | public | メソッド | 動作中の処理やリソースを安全に停止・解放します。 |
メソッド詳細
DiscordNotifier
private DiscordNotifier(JavaPlugin plugin, JDA jda, String channelId, boolean onBoot, boolean onPreStart, boolean onCreated, boolean onStarted, boolean onEnded, boolean includeRewards, ConfigurationSection perType)依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。
引数
JavaPlugin pluginJDA jdaString channelIdboolean onBootboolean onPreStartboolean onCreatedboolean onStartedboolean onEndedboolean includeRewardsConfigurationSection perType
throws
なし
主要な呼び出し順
目立つ内部呼び出しは抽出されませんでした。
create
public static DiscordNotifier create(JavaPlugin plugin)create の主要処理を担当します。
引数
JavaPlugin plugin
throws
なし
主要な呼び出し順
getConfiggetConfigurationSectiongetBooleangetStringisEmptygetLoggerwarningcreateDefault
getJda
public JDA getJda()RankingPlugin 側で追加リスナー登録などを行うために公開。
引数
- 引数なし
throws
なし
主要な呼び出し順
目立つ内部呼び出しは抽出されませんでした。
notifyBootWithEvents
public void notifyBootWithEvents(List<SimpleEvent> running, List<SimpleEvent> upcoming)notifyBootWithEvents の主要処理を担当します。
引数
List<SimpleEvent> runningList<SimpleEvent> upcoming
throws
なし
主要な呼び出し順
getTextChannelByIdgetLoggerwarninggetNamegetDescriptiongetVersionsetTitlesetColor
allow
private boolean allow(String type, Phase phase)allow の主要処理を担当します。
引数
String typePhase phase
throws
なし
主要な呼び出し順
isConfigurationSectionrequireNonNullgetConfigurationSectiongetBoolean
notifyGeneric
public void notifyGeneric(String type, String name, Phase phase, LocalDateTime start, LocalDateTime end, Map<Integer, Long> topRewards /* null可 */, String paramsPreview /* 任意 */)notifyGeneric の主要処理を担当します。
引数
String typeString namePhase phaseLocalDateTime startLocalDateTime endMap<Integer, Long> topRewards /* null可 */String paramsPreview /* 任意 */
throws
なし
主要な呼び出し順
allowgetTextChannelByIdsetTitlesetColoraddFieldsafeatZonetoString
safe
private static String safe(String s)safe の主要処理を担当します。
引数
String s
throws
なし
主要な呼び出し順
目立つ内部呼び出しは抽出されませんでした。
notifyShutdown
public void notifyShutdown()notifyShutdown の主要処理を担当します。
引数
- 引数なし
throws
なし
主要な呼び出し順
getTextChannelByIdgetLoggerwarninggetNamegetDescriptiongetVersionsetTitlesetColor
notifyShutdownSync
public boolean notifyShutdownSync(long timeoutMillis)停止時に確実に届けたい場合のブロッキング版（タイムアウト付き）
引数
long timeoutMillis
throws
なし
主要な呼び出し順
getTextChannelByIdgetLoggerwarninggetNamegetDescriptiongetVersionsetTitlesetColor
shutdownGracefully
public void shutdownGracefully(long timeoutMillis)動作中の処理やリソースを安全に停止・解放します。
引数
long timeoutMillis
throws
なし
主要な呼び出し順
shutdowncurrentTimeMillisgetStatussleepcurrentThreadinterruptgetLoggerwarning
shutdown
public void shutdown()動作中の処理やリソースを安全に停止・解放します。
引数
- 引数なし
throws
なし
主要な呼び出し順
shutdownNow
代表的な処理フロー
- shutdownGracefully フロー
shutdownGracefully → shutdown → currentTimeMillis → getStatus → sleep → currentThread動作中の処理やリソースを安全に停止・解放します。 - shutdown フロー
shutdown → shutdownNow動作中の処理やリソースを安全に停止・解放します。 - create フロー
create → getConfig → getConfigurationSection → getBoolean → getString → isEmptycreate の主要処理を担当します。 - notifyBootWithEvents フロー
notifyBootWithEvents → getTextChannelById → getLogger → warning → getName → getDescriptionnotifyBootWithEvents の主要処理を担当します。 - notifyGeneric フロー
notifyGeneric → allow → getTextChannelById → setTitle → setColor → addFieldnotifyGeneric の主要処理を担当します。
外部との接点
Web ルート
このクラス内に目立つ Web ルート定義は見つかりませんでした。
SQL / テーブル
テーブル名の抽出はありませんでした。
関連クラス
- 関連クラスは抽出されませんでした。
補足
- メソッド説明と処理フローは、Javadoc とソース本体の呼び出し列から自動要約しています。
- 匿名クラスや複雑なラムダ初期化を多用する箇所では、一部のフィールド / 呼び出し順が簡略表示になる場合があります。