RankingPlugin の外部連携イベント発火ヘルパー。

2Fields
1Constructors
7Methods
62Lines
Package
com.example.rankingplugin.api
Source
api/RankingApiEventPublisher.java
Kind
class
Roles
非同期 / スケジューラ初期化 / ブートストラップ
このクラスにも章立て解説を追加しています。 自動抽出の一覧だけでなく、下の『重点クラスの詳細解説』で読む順番・内部サブシステム・変更時の注意点まで追えます。 全クラス章立てガイドを見る

クラス説明

RankingPlugin の外部連携イベント発火ヘルパー。
Bukkit イベントとして同期スレッドで発火する。

責務と見どころ

重点クラスの詳細解説

RankingPlugin の外部連携イベント発火ヘルパー。api パッケージの 小規模クラスで、スケジューラを確認する起点です。全面展開版では、他の重点クラスと同じ章立てで読めるように補強しています。

最初に追う読む順番

  1. RankingApiEventPublisher
    依存オブジェクトと初期状態を束ね、このクラスが担当するランタイムの前提を固めます。
  2. init
    不足テーブル・設定・内部状態を先に揃える入口です。変更を入れる前提条件の確認地点になります。
  3. shutdown
    後片付けと停止の出口です。残骸や再ログイン後の不整合はここを確認します。
  4. publishScoreChanged
    publishScoreChanged の主要処理を担当します。
  5. publishBingoAchieved
    publishBingoAchieved の主要処理を担当します。
  6. publishBossSpawned
    publishBossSpawned の主要処理を担当します。
  7. fire
    fire の主要処理を担当します。

内部サブシステムの地図

起動・前提準備

初期テーブル、依存状態、定期処理の点灯など、このクラスが動き始める前提をまとめています。

主なメソッド
主なフィールド

終了処理と掃除

停止時やフロー終端で残る実体・タスク・キャッシュを戻す出口です。

主なメソッド
主なフィールド
なし

代表フロー詳解

初期化と起動の流れ

  1. RankingApiEventPublisher
  2. init

このクラスが前提状態を揃え、外部から利用可能な形まで立ち上がる流れです。新規依存の追加や起動失敗の調査はまずここから追います。

反映・保存・終了の流れ

  1. shutdown

結果を保持し、必要なら永続化し、最後に掃除まで行う出口です。画面更新だけ合って保存が壊れるケースや残骸が残るケースの確認に向きます。

変更時の注意点

フィールド

VisibilityTypeName役割
privateJavaPluginpluginプラグイン本体参照です。
privateStringserverIdserverId の状態を保持します。

コンストラクタ / 初期化

Signature説明主要呼び出し
private RankingApiEventPublisher()依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。主要呼び出しなし

メソッド索引

NameVisibilityKind説明
RankingApiEventPublisherprivateコンストラクタ依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。
initpublicメソッド初期化と各種登録を行い、機能を有効化します。
shutdownpublicメソッド動作中の処理やリソースを安全に停止・解放します。
publishScoreChangedpublicメソッドpublishScoreChanged の主要処理を担当します。
publishBingoAchievedpublicメソッドpublishBingoAchieved の主要処理を担当します。
publishBossSpawnedpublicメソッドpublishBossSpawned の主要処理を担当します。
fireprivateメソッドfire の主要処理を担当します。

メソッド詳細

RankingApiEventPublisher

コンストラクタprivate
private RankingApiEventPublisher()

依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。

引数

throws

なし

主要な呼び出し順

目立つ内部呼び出しは抽出されませんでした。

init

メソッドpublicstatic
public static void init(JavaPlugin pluginInstance, String configuredServerId)

初期化と各種登録を行い、機能を有効化します。

引数

throws

なし

主要な呼び出し順

目立つ内部呼び出しは抽出されませんでした。

shutdown

メソッドpublicstatic
public static void shutdown()

動作中の処理やリソースを安全に停止・解放します。

引数

throws

なし

主要な呼び出し順

目立つ内部呼び出しは抽出されませんでした。

publishScoreChanged

メソッドpublicstatic
public static void publishScoreChanged(String playerName, long oldScore, long newScore)

publishScoreChanged の主要処理を担当します。

引数

throws

なし

主要な呼び出し順

fire

publishBingoAchieved

メソッドpublicstatic
public static void publishBingoAchieved(UUID playerId, String playerName, String boardType, int linesBefore, int linesAfter, int triggeredNumber)

publishBingoAchieved の主要処理を担当します。

引数

throws

なし

主要な呼び出し順

fire

publishBossSpawned

メソッドpublicstatic
public static void publishBossSpawned(String bossType, String displayName, int level, Location location)

publishBossSpawned の主要処理を担当します。

引数

throws

なし

主要な呼び出し順

getWorldfiregetNamegetXgetYgetZ

fire

メソッドprivatestatic
private static void fire(Event event)

fire の主要処理を担当します。

引数

throws

なし

主要な呼び出し順

isPrimaryThreadgetPluginManagercallEventgetSchedulerrunTask

代表的な処理フロー

  1. publishBossSpawned フロー
    publishBossSpawned → getWorld → fire → getName → getX → getY
    publishBossSpawned の主要処理を担当します。
  2. fire フロー
    fire → isPrimaryThread → getPluginManager → callEvent → getScheduler → runTask
    fire の主要処理を担当します。
  3. publishBingoAchieved フロー
    publishBingoAchieved → fire
    publishBingoAchieved の主要処理を担当します。

外部との接点

Web ルート

このクラス内に目立つ Web ルート定義は見つかりませんでした。

SQL / テーブル

テーブル名の抽出はありませんでした。

関連クラス

補足