Ranking Plugin Api Provider を担当するclassです。

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

クラス説明

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

責務と見どころ

重点クラスの詳細解説

Ranking Plugin Api Provider を担当するclassです。api パッケージの 小規模クラスで、責務境界の要点を確認する起点です。全面展開版では、他の重点クラスと同じ章立てで読めるように補強しています。

最初に追う読む順番

  1. RankingPluginApiProvider
    依存オブジェクトと初期状態を束ね、このクラスが担当するランタイムの前提を固めます。
  2. getServerId
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
  3. getScore
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
  4. addScore
    addScore の主要処理を担当します。
  5. setScore
    setScore の主要処理を担当します。
  6. getRank
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
  7. getTopScores
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
  8. getMonthlyTop
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

内部サブシステムの地図

代表フロー詳解

通常運用の中心フロー

  1. setScore
  2. setCurrency

イベント受理、判定、状態更新、通知までの主経路です。体感不具合や想定外の分岐はこの流れのどこで止まるかを見ると切り分けやすいです。

反映・保存・終了の流れ

  1. setScore
  2. setCurrency

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

変更時の注意点

フィールド

VisibilityTypeName役割
privateStringserverIdserverId の状態を保持します。
privateScoreServicescoreService関連サービスへの参照です。
privateCurrencyServicecurrencyService関連サービスへの参照です。
privateOnlineStatusServiceonlineStatusService関連サービスへの参照です。
privateJackpotServicejackpotService関連サービスへの参照です。
privateMiniJackpotServiceminiJackpotService関連サービスへの参照です。

コンストラクタ / 初期化

Signature説明主要呼び出し
public RankingPluginApiProvider(String serverId, ScoreService scoreService, CurrencyService currencyService, OnlineStatusService onlineStatusService, JackpotService jackpotService, MiniJackpotService miniJackpotService)依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。主要呼び出しなし

メソッド索引

NameVisibilityKind説明
RankingPluginApiProviderpublicコンストラクタ依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。
getServerIdpublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getScorepublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
addScorepublicメソッドaddScore の主要処理を担当します。
setScorepublicメソッドsetScore の主要処理を担当します。
getRankpublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getTopScorespublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getMonthlyToppublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getCurrencypublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
addCurrencypublicメソッドaddCurrency の主要処理を担当します。
setCurrencypublicメソッドsetCurrency の主要処理を担当します。
isOnlineHerepublicメソッド条件判定を行い、後続処理の分岐に使える真偽値を返します。
isOnlineElsewherepublicメソッド条件判定を行い、後続処理の分岐に使える真偽値を返します。
getOnlineServerspublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getJackpotPoolpublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getMiniJackpotPoolpublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

メソッド詳細

RankingPluginApiProvider

コンストラクタpublic
public RankingPluginApiProvider(String serverId, ScoreService scoreService, CurrencyService currencyService, OnlineStatusService onlineStatusService, JackpotService jackpotService, MiniJackpotService miniJackpotService)

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

引数

throws

なし

主要な呼び出し順

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

getServerId

メソッドpublic
public String getServerId()

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

引数

throws

なし

主要な呼び出し順

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

getScore

メソッドpublic
public long getScore(String playerName)

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

引数

throws

なし

主要な呼び出し順

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

addScore

メソッドpublic
public long addScore(String playerName, long delta)

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

引数

throws

なし

主要な呼び出し順

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

setScore

メソッドpublic
public void setScore(String playerName, long score)

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

引数

throws

なし

主要な呼び出し順

saveScore

getRank

メソッドpublic
public int getRank(String playerName)

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

引数

throws

なし

主要な呼び出し順

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

getTopScores

メソッドpublic
public List<RankingEntry> getTopScores(int limit)

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

引数

throws

なし

主要な呼び出し順

streammapgetKeygetValuecollecttoList

getMonthlyTop

メソッドpublic
public List<RankingEntry> getMonthlyTop(YearMonth month, int limit)

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

引数

throws

なし

主要な呼び出し順

streammapgetKeygetValuecollecttoList

getCurrency

メソッドpublic
public long getCurrency(String playerName)

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

引数

throws

なし

主要な呼び出し順

getBalance

addCurrency

メソッドpublic
public long addCurrency(String playerName, long amount)

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

引数

throws

なし

主要な呼び出し順

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

setCurrency

メソッドpublic
public void setCurrency(String playerName, long amount)

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

引数

throws

なし

主要な呼び出し順

setBalance

isOnlineHere

メソッドpublic
public boolean isOnlineHere(String playerName)

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

引数

throws

なし

主要な呼び出し順

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

isOnlineElsewhere

メソッドpublic
public boolean isOnlineElsewhere(String playerName)

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

引数

throws

なし

主要な呼び出し順

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

getOnlineServers

メソッドpublic
public Set<String> getOnlineServers(String playerName)

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

引数

throws

なし

主要な呼び出し順

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

getJackpotPool

メソッドpublic
public long getJackpotPool()

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

引数

throws

なし

主要な呼び出し順

getPoolAmount

getMiniJackpotPool

メソッドpublic
public long getMiniJackpotPool()

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

引数

throws

なし

主要な呼び出し順

getPoolAmount

代表的な処理フロー

  1. getMonthlyTop フロー
    getMonthlyTop → stream → map → getKey → getValue → collect
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
  2. getTopScores フロー
    getTopScores → stream → map → getKey → getValue → collect
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
  3. getCurrency フロー
    getCurrency → getBalance
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
  4. getJackpotPool フロー
    getJackpotPool → getPoolAmount
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
  5. getMiniJackpotPool フロー
    getMiniJackpotPool → getPoolAmount
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

外部との接点

Web ルート

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

SQL / テーブル

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

関連クラス

補足