Class: MonthlyRankingRewardService

Monthly Ranking Reward Service に関するサービス層・業務処理を担当します。

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

クラス説明

クラス直前の Javadoc は見つかりませんでした。ソースとメソッド構成から責務を補完しています。

責務と見どころ

重点クラスの詳細解説

Monthly Ranking Reward Service に関するサービス層・業務処理を担当します。(root) パッケージの中でも 661 行規模の中核クラスで、運用中の主ループ・永続化境界・Web 導線が一か所に集まっています。中規模クラス群の中では変更影響が広く、章立てで読む価値が高いため重点解説へ追加しています。

最初に追う読む順番

  1. MonthlyRankingRewardService
    依存オブジェクトと初期状態を束ね、このクラスが担当するランタイムの前提を固めます。
  2. ensureConfigDefaults
    不足テーブル・設定・内部状態を先に揃える入口です。変更を入れる前提条件の確認地点になります。
  3. createRankItem
    実体や対象状態を作る段階で、後続フローがどのデータを前提に動くかを掴めます。
  4. openRewardGui
    実体や対象状態を作る段階で、後続フローがどのデータを前提に動くかを掴めます。
  5. openMain
    実体や対象状態を作る段階で、後続フローがどのデータを前提に動くかを掴めます。
  6. openEditor
    実体や対象状態を作る段階で、後続フローがどのデータを前提に動くかを掴めます。
  7. buildPrestigePool
    表示用または出力用のデータを組み立てます。
  8. buildBasicPool
    表示用または出力用のデータを組み立てます。
  9. handleMainClick
    運用中の中心ループです。イベント受理から状態更新までの主経路を追えます。

内部サブシステムの地図

状態反映と永続化

メモリ状態と保存状態を揃え、結果を次の呼び出しや画面表示へ繋ぐ部分です。

主なメソッド
saveConfiguredMaterials saveDataConfig
主なフィールド
plugin

外部公開ルートとレスポンス

Web から見えるエンドポイント、セッション解決、レスポンス整形を含みます。画面追加や API 変更時の起点になります。

主なメソッド
openRewardGui handleMainClick handleEditorClick openMain openEditor
主なフィールド
なし

代表フロー詳解

反映・保存・終了の流れ

  1. saveConfiguredMaterials
  2. saveDataConfig

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

変更時の注意点

  • Bukkit 実体やワールド状態を触る処理はスレッド境界を崩さないようにしてください。重い計算だけを分離し、実体操作は既存の同期経路へ寄せるのが安全です。
  • DB スキーマと実装が密結合です。列追加や型変更を行うときは ensure / load / save 系をセットで見直し、古いデータとの互換も確認してください。
  • Web 入口を増やすときは、認証・権限・レスポンス形式・キャッシュ更新を一緒に設計すると後戻りが減ります。

フィールド

VisibilityTypeName役割
privateStringCONFIG_ROOTCONFIG_ROOT の状態を保持します。
privateint[]RANK_LIMITSRANK_LIMITS の状態を保持します。
privateintBROWSE_PAGE_SIZEBROWSE_PAGE_SIZE の状態を保持します。
privateRankingPluginpluginプラグイン本体参照です。
privateFiledataFiledataFile の状態を保持します。
privateYamlConfigurationdataConfigdataConfig の状態を保持します。
privateList<Material>prestigePoolprestigePool の状態を保持します。
privateList<Material>basicPoolbasicPool の状態を保持します。

コンストラクタ / 初期化

Signature説明主要呼び出し
public MonthlyRankingRewardService(RankingPlugin plugin)依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。getDataFolder → loadConfiguration → unmodifiableList → buildPrestigePool → buildBasicPool → ensureConfigDefaults

メソッド索引

NameVisibilityKind説明
MonthlyRankingRewardServicepublicコンストラクタ依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。
openRewardGuipublicメソッドopenRewardGui の主要処理を担当します。
awardMonthlyRankingRewardspublicメソッドawardMonthlyRankingRewards の主要処理を担当します。
onInventoryClickpublicイベント処理イベント発生時の分岐と後続処理を担当します。
onJoinpublicイベント処理イベント発生時の分岐と後続処理を担当します。
handleMainClickprivateメソッド入力やリクエストを受けて、検証・処理・応答までをまとめて担当します。
handleEditorClickprivateメソッド入力やリクエストを受けて、検証・処理・応答までをまとめて担当します。
toggleMaterialprivateメソッドtoggleMaterial の主要処理を担当します。
openMainprivateメソッドopenMain の主要処理を担当します。
createRankItemprivateメソッドcreateRankItem の主要処理を担当します。
openEditorprivateメソッドWeb リクエストの受理とレスポンス生成を担当します。
deliverOrQueueprivateメソッドdeliverOrQueue の主要処理を担当します。
deliverPendingRewardsprivateメソッドdeliverPendingRewards の主要処理を担当します。
deliverPendingFromKeyprivateメソッドdeliverPendingFromKey の主要処理を担当します。
deliverNowprivateメソッドdeliverNow の主要処理を担当します。
queuePendingprivateメソッドqueuePending の主要処理を担当します。
isAlreadyAwardedprivateメソッド条件判定を行い、後続処理の分岐に使える真偽値を返します。
markAwardedprivateメソッドmarkAwarded の主要処理を担当します。
resolveStorageKeyprivateメソッドresolveStorageKey の主要処理を担当します。
readItemStackListprivateメソッドreadItemStackList の主要処理を担当します。
parseMonthprivateメソッド入力テキストや設定値を解析して内部表現へ変換します。
getConfiguredMaterialsprivateメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
saveConfiguredMaterialsprivateメソッド状態を永続化または更新し、最新状態へ反映します。
getRankLimitprivateメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getPoolForRankprivateメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getAllowedMaterialsprivateメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
ensureConfigDefaultsprivateメソッド必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。
saveDataConfigprivateメソッド状態を永続化または更新し、最新状態へ反映します。
buildPrestigePoolprivateメソッド表示用または出力用のデータを組み立てます。
buildBasicPoolprivateメソッド表示用または出力用のデータを組み立てます。
isWoodMaterialprivateメソッド条件判定を行い、後続処理の分岐に使える真偽値を返します。
isStoneMaterialprivateメソッド条件判定を行い、後続処理の分岐に使える真偽値を返します。
isBasicOreMaterialprivateメソッド条件判定を行い、後続処理の分岐に使える真偽値を返します。
addIfPresentprivateメソッドaddIfPresent の主要処理を担当します。
fillprivateメソッドfill の主要処理を担当します。
itemprivateメソッドitem の主要処理を担当します。
summarizeItemsprivateメソッドsummarizeItems の主要処理を担当します。
prettyNameprivateメソッドprettyName の主要処理を担当します。
normalizeNameprivateメソッドnormalizeName の主要処理を担当します。
safeprivateメソッドsafe の主要処理を担当します。

メソッド詳細

MonthlyRankingRewardService

コンストラクタpublic
public MonthlyRankingRewardService(RankingPlugin plugin)

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

引数

  • RankingPlugin plugin

throws

なし

主要な呼び出し順

getDataFolderloadConfigurationunmodifiableListbuildPrestigePoolbuildBasicPoolensureConfigDefaults

openRewardGui

メソッドpublic
public boolean openRewardGui(CommandSender sender)

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

引数

  • CommandSender sender

throws

なし

主要な呼び出し順

sendMessageisOpopenMain

awardMonthlyRankingRewards

メソッドpublic
public void awardMonthlyRankingRewards(YearMonth month, Map<String, Long> scores)

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

引数

  • YearMonth month
  • Map<String, Long> scores

throws

なし

主要な呼び出し順

isEmptyentrySetstreamfiltergetKeyisBlanksortedcomparingLong

onInventoryClick

イベント処理public
public void onInventoryClick(InventoryClickEvent event)

イベント発生時の分岐と後続処理を担当します。

引数

  • InventoryClickEvent event

throws

なし

主要な呼び出し順

getWhoClickedgetViewgetTopInventorygetHoldersetCancelledgetClickedInventoryhandleMainClickgetRawSlot

onJoin

イベント処理public
public void onJoin(PlayerJoinEvent event)

イベント発生時の分岐と後続処理を担当します。

引数

  • PlayerJoinEvent event

throws

なし

主要な呼び出し順

getSchedulerrunTaskLaterdeliverPendingRewardsgetPlayer

handleMainClick

メソッドprivate
private void handleMainClick(Player player, int slot)

入力やリクエストを受けて、検証・処理・応答までをまとめて担当します。

引数

  • Player player
  • int slot

throws

なし

主要な呼び出し順

openEditor

handleEditorClick

メソッドprivate
private void handleEditorClick(Player player, RewardGuiHolder holder, int slot)

入力やリクエストを受けて、検証・処理・応答までをまとめて担当します。

引数

  • Player player
  • RewardGuiHolder holder
  • int slot

throws

なし

主要な呼び出し順

getAllowedMaterialssizetoggleMaterialgetConfiguredMaterialsremovesaveConfiguredMaterialssendMessageprettyName

toggleMaterial

メソッドprivate
private void toggleMaterial(Player player, int rank, Material material, int page)

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

引数

  • Player player
  • int rank
  • Material material
  • int page

throws

なし

主要な呼び出し順

getConfiguredMaterialscontainsremovesaveConfiguredMaterialssendMessageprettyNameopenEditorgetRankLimit

openMain

メソッドprivate
private void openMain(Player player)

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

引数

  • Player player

throws

なし

主要な呼び出し順

createInventoryfillsetItemcreateRankItemitemopenInventory

createRankItem

メソッドprivate
private ItemStack createRankItem(int rank)

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

引数

  • int rank

throws

なし

主要な呼び出し順

getPoolForRankgetConfiguredMaterialsgetRankLimitsizeisEmptyprettyNameitemvalueOf

openEditor

メソッドprivate
private void openEditor(Player player, int rank, int requestedPage)

Web リクエストの受理とレスポンス生成を担当します。

引数

  • Player player
  • int rank
  • int requestedPage

throws

なし

主要な呼び出し順

createInventoryfillgetAllowedMaterialsmaxsizemingetConfiguredMaterialscontains

deliverOrQueue

メソッドprivate
private void deliverOrQueue(String playerName, List<ItemStack> rewards, YearMonth month, int rank)

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

引数

  • String playerName
  • List<ItemStack> rewards
  • YearMonth month
  • int rank

throws

なし

主要な呼び出し順

getPlayerExactisOnlinedeliverNowqueuePending

deliverPendingRewards

メソッドprivate
private void deliverPendingRewards(Player player)

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

引数

  • Player player

throws

なし

主要な呼び出し順

isOnlinedeliverPendingFromKeygetUniqueIdtoStringgetNametoLowerCasesaveDataConfig

deliverPendingFromKey

メソッドprivate
private boolean deliverPendingFromKey(Player player, String key)

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

引数

  • Player player
  • String key

throws

なし

主要な呼び出し順

getConfigurationSectiongetKeysgetStringgetIntreadItemStackListisEmptydeliverNowparseMonth

deliverNow

メソッドprivate
private void deliverNow(Player player, List<ItemStack> rewards, YearMonth month, int rank, boolean notify)

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

引数

  • Player player
  • List<ItemStack> rewards
  • YearMonth month
  • int rank
  • boolean notify

throws

なし

主要な呼び出し順

isOnlineisEmptystreamfiltermapcollecttoCollectiongetInventory

queuePending

メソッドprivate
private void queuePending(String playerName, List<ItemStack> rewards, YearMonth month, int rank)

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

引数

  • String playerName
  • List<ItemStack> rewards
  • YearMonth month
  • int rank

throws

なし

主要な呼び出し順

resolveStorageKeycurrentTimeMillistoStringstreammapcollecttoList

isAlreadyAwarded

メソッドprivate
private boolean isAlreadyAwarded(String monthKey, int rank, String playerName)

条件判定を行い、後続処理の分岐に使える真偽値を返します。

引数

  • String monthKey
  • int rank
  • String playerName

throws

なし

主要な呼び出し順

getBooleannormalizeName

markAwarded

メソッドprivate
private void markAwarded(String monthKey, int rank, String playerName)

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

引数

  • String monthKey
  • int rank
  • String playerName

throws

なし

主要な呼び出し順

normalizeName

resolveStorageKey

メソッドprivate
private String resolveStorageKey(String playerName)

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

引数

  • String playerName

throws

なし

主要な呼び出し順

getOfflinePlayergetUniqueIdtoStringnormalizeName

readItemStackList

メソッドprivate
private List<ItemStack> readItemStackList(String path)

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

引数

  • String path

throws

なし

主要な呼び出し順

getListclone

parseMonth

メソッドprivate
private YearMonth parseMonth(String text)

入力テキストや設定値を解析して内部表現へ変換します。

引数

  • String text

throws

なし

主要な呼び出し順

parse

getConfiguredMaterials

メソッドprivate
private List<Material> getConfiguredMaterials(int rank)

必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

引数

  • int rank

throws

なし

主要な呼び出し順

getConfiggetStringListgetAllowedMaterialsmatchMaterialcontainssizegetRankLimit

saveConfiguredMaterials

メソッドprivate
private void saveConfiguredMaterials(int rank, List<Material> materials)

状態を永続化または更新し、最新状態へ反映します。

引数

  • int rank
  • List<Material> materials

throws

なし

主要な呼び出し順

getAllowedMaterialscontainsnamesizegetRankLimitgetConfigsaveConfig

getRankLimit

メソッドprivate
private int getRankLimit(int rank)

必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

引数

  • int rank

throws

なし

主要な呼び出し順

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

getPoolForRank

メソッドprivate
private RewardPool getPoolForRank(int rank)

必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

引数

  • int rank

throws

なし

主要な呼び出し順

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

getAllowedMaterials

メソッドprivate
private List<Material> getAllowedMaterials(int rank)

必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

引数

  • int rank

throws

なし

主要な呼び出し順

getPoolForRank

ensureConfigDefaults

メソッドprivate
private void ensureConfigDefaults()

必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。

引数

  • 引数なし

throws

なし

主要な呼び出し順

getConfigcontainsgetRankLimitgetPoolForRanknamesaveConfig

saveDataConfig

メソッドprivate
private void saveDataConfig()

状態を永続化または更新し、最新状態へ反映します。

引数

  • 引数なし

throws

なし

主要な呼び出し順

savegetLoggerwarninggetMessage

buildPrestigePool

メソッドprivate
private List<Material> buildPrestigePool()

表示用または出力用のデータを組み立てます。

引数

  • 引数なし

throws

なし

主要な呼び出し順

noneOfaddIfPresentstreamvaluesfilternamestartsWithcontains

buildBasicPool

メソッドprivate
private List<Material> buildBasicPool()

表示用または出力用のデータを組み立てます。

引数

  • 引数なし

throws

なし

主要な呼び出し順

noneOfvaluesisItemnamestartsWithisEdibleisWoodMaterialisStoneMaterial

isWoodMaterial

メソッドprivate
private boolean isWoodMaterial(Material material)

条件判定を行い、後続処理の分岐に使える真偽値を返します。

引数

  • Material material

throws

なし

主要な呼び出し順

namecontains

isStoneMaterial

メソッドprivate
private boolean isStoneMaterial(Material material)

条件判定を行い、後続処理の分岐に使える真偽値を返します。

引数

  • Material material

throws

なし

主要な呼び出し順

namecontains

isBasicOreMaterial

メソッドprivate
private boolean isBasicOreMaterial(Material material)

条件判定を行い、後続処理の分岐に使える真偽値を返します。

引数

  • Material material

throws

なし

主要な呼び出し順

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

addIfPresent

メソッドprivate
private void addIfPresent(Set<Material> set, String... names)

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

引数

  • Set<Material> set
  • String... names

throws

なし

主要な呼び出し順

matchMaterial

fill

メソッドprivate
private void fill(Inventory inv, Material material, String name)

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

引数

  • Inventory inv
  • Material material
  • String name

throws

なし

主要な呼び出し順

itemgetSizesetItem

item

メソッドprivate
private ItemStack item(Material material, String name, String... lore)

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

引数

  • Material material
  • String name
  • String... lore

throws

なし

主要な呼び出し順

getItemMetasetDisplayNamesetLoreasListaddItemFlagssetItemMeta

summarizeItems

メソッドprivate
private String summarizeItems(List<ItemStack> items)

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

引数

  • List<ItemStack> items

throws

なし

主要な呼び出し順

streamfiltermapprettyNamegetTypegetAmountcollectjoining

prettyName

メソッドprivate
private String prettyName(Material material)

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

引数

  • Material material

throws

なし

主要な呼び出し順

nametoLowerCasereplacesplitisBlankisEmptyappendtoUpperCase

normalizeName

メソッドprivate
private String normalizeName(String playerName)

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

引数

  • String playerName

throws

なし

主要な呼び出し順

safetoLowerCase

safe

メソッドprivate
private String safe(String value)

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

引数

  • String value

throws

なし

主要な呼び出し順

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

代表的な処理フロー

  1. 初期化フロー
    MonthlyRankingRewardService → getDataFolder → loadConfiguration → unmodifiableList → buildPrestigePool → buildBasicPool
    依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。
  2. onInventoryClick フロー
    onInventoryClick → getWhoClicked → getView → getTopInventory → getHolder → setCancelled
    イベント発生時の分岐と後続処理を担当します。
  3. onJoin フロー
    onJoin → getScheduler → runTaskLater → deliverPendingRewards → getPlayer
    イベント発生時の分岐と後続処理を担当します。
  4. handleEditorClick フロー
    handleEditorClick → getAllowedMaterials → size → toggleMaterial → getConfiguredMaterials → remove
    入力やリクエストを受けて、検証・処理・応答までをまとめて担当します。
  5. handleMainClick フロー
    handleMainClick → openEditor
    入力やリクエストを受けて、検証・処理・応答までをまとめて担当します。
  6. saveConfiguredMaterials フロー
    saveConfiguredMaterials → getAllowedMaterials → contains → name → size → getRankLimit
    状態を永続化または更新し、最新状態へ反映します。

外部との接点

Web ルート

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

SQL / テーブル

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

関連クラス

補足