Class: PlayerCardService

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

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

クラス説明

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

責務と見どころ

重点クラスの詳細解説

Player Card Service に関するサービス層・業務処理を担当します。card パッケージの中でも 515 行規模の中核クラスで、永続化境界・スケジューラが一か所に集まっています。中規模クラス群の中では変更影響が広く、章立てで読む価値が高いため重点解説へ追加しています。

最初に追う読む順番

  1. PlayerCardService
    依存オブジェクトと初期状態を束ね、このクラスが担当するランタイムの前提を固めます。
  2. ensureTables
    不足テーブル・設定・内部状態を先に揃える入口です。変更を入れる前提条件の確認地点になります。
  3. ensureUtf8mb4Table
    不足テーブル・設定・内部状態を先に揃える入口です。変更を入れる前提条件の確認地点になります。
  4. ensurePlayerCardColumns
    不足テーブル・設定・内部状態を先に揃える入口です。変更を入れる前提条件の確認地点になります。
  5. ensureColumnDefinition
    不足テーブル・設定・内部状態を先に揃える入口です。変更を入れる前提条件の確認地点になります。
  6. issueYellowCard
    条件判定を行い、後続処理の分岐に使える真偽値を返します。
  7. issueRedCard
    条件判定を行い、後続処理の分岐に使える真偽値を返します。
  8. clearCards
    DB への問い合わせまたは更新処理を担当します。
  9. getStatus
    必要な状態を取得し、呼び出し側で利用しやすい形へ返します。

内部サブシステムの地図

状態反映と永続化

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

主なメソッド
insertHistory
主なフィールド
plugin ds serverId

代表フロー詳解

通常運用の中心フロー

  1. insertHistory

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

反映・保存・終了の流れ

  1. insertHistory

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

変更時の注意点

  • Bukkit 実体やワールド状態を触る処理はスレッド境界を崩さないようにしてください。重い計算だけを分離し、実体操作は既存の同期経路へ寄せるのが安全です。
  • DB スキーマと実装が密結合です。列追加や型変更を行うときは ensure / load / save 系をセットで見直し、古いデータとの互換も確認してください。

外部接点

主な永続化テーブル

SQL 文字列から抽出できた主要テーブルです。スキーマ変更時の確認用です。

player_card_stateplayer_card_historycreateplayer_name

フィールド

VisibilityTypeName役割
privateZoneIdJSTJST の状態を保持します。
privateDateTimeFormatterTS_FMTTS_FMT の状態を保持します。
privateStringSTATUS_YELLOWSTATUS_YELLOW の状態を保持します。
privateStringSTATUS_REDSTATUS_RED の状態を保持します。
privateRankingPluginpluginプラグイン本体参照です。
privateDataSourcedsDB 接続元を保持します。
privateStringserverIdserverId の状態を保持します。

コンストラクタ / 初期化

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

メソッド索引

NameVisibilityKind説明
PlayerCardServicepublicコンストラクタ依存オブジェクトや初期状態を受け取り、このクラスの動作を開始できる状態へ組み立てます。
ensureTablespublicメソッド必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。
ensureUtf8mb4Tableprivateメソッド必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。
ensurePlayerCardColumnsprivateメソッド必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。
ensureColumnDefinitionprivateメソッド必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。
issueYellowCardpublicメソッド条件判定を行い、後続処理の分岐に使える真偽値を返します。
issueRedCardpublicメソッド条件判定を行い、後続処理の分岐に使える真偽値を返します。
clearCardspublicメソッドDB への問い合わせまたは更新処理を担当します。
getStatuspublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
listActiveCardspublicメソッドDB への問い合わせまたは更新処理を担当します。
getYellowToRedThresholdpublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
getRedBanReasonpublicメソッド必要な状態を取得し、呼び出し側で利用しやすい形へ返します。
upsertStateprivateメソッドDB への問い合わせまたは更新処理を担当します。
insertHistoryprivateメソッド状態を永続化または更新し、最新状態へ反映します。
selectStatusForUpdateprivateメソッドDB への問い合わせまたは更新処理を担当します。
mapStatusRowprivateメソッドmapStatusRow の主要処理を担当します。
scheduleBanprivateメソッドscheduleBan の主要処理を担当します。
resolveTargetNameprivateメソッドresolveTargetName の主要処理を担当します。
sanitizeReasonprivateメソッドsanitizeReason の主要処理を担当します。
sanitizeActorprivateメソッドsanitizeActor の主要処理を担当します。
formatStatusLinepublicメソッドformatStatusLine の主要処理を担当します。

メソッド詳細

PlayerCardService

コンストラクタpublic
public PlayerCardService(RankingPlugin plugin, DataSource ds, String serverId)

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

引数

  • RankingPlugin plugin
  • DataSource ds
  • String serverId

throws

なし

主要な呼び出し順

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

ensureTables

メソッドpublic
public void ensureTables()

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

引数

  • 引数なし

throws

なし

主要な呼び出し順

getConnectioncreateStatementexecuteUpdateplayer_card_stateidx_player_card_state_statusidx_player_card_state_yellow_countidx_player_card_state_last_issued_atplayer_card_history

ensureUtf8mb4Table

メソッドprivate
private void ensureUtf8mb4Table(Connection c, String tableName)

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

引数

  • Connection c
  • String tableName

throws

なし

主要な呼び出し順

createStatementexecuteUpdategetLoggerwarninggetMessage

ensurePlayerCardColumns

メソッドprivate
private void ensurePlayerCardColumns(Connection c)

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

引数

  • Connection c

throws

なし

主要な呼び出し順

ensureColumnDefinition

ensureColumnDefinition

メソッドprivate
private void ensureColumnDefinition(Connection c, String tableName, String columnName, String definition)

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

引数

  • Connection c
  • String tableName
  • String columnName
  • String definition

throws

なし

主要な呼び出し順

createStatementexecuteUpdategetLoggerwarninggetMessage

issueYellowCard

メソッドpublic
public CardActionResult issueYellowCard(CommandSender issuer, OfflinePlayer target, String fallbackName, String reason)

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

引数

  • CommandSender issuer
  • OfflinePlayer target
  • String fallbackName
  • String reason

throws

なし

主要な呼び出し順

sanitizeActorgetNameresolveTargetNameisBlankerrorgetUniqueIdsanitizeReasongetYellowToRedThreshold

issueRedCard

メソッドpublic
public CardActionResult issueRedCard(CommandSender issuer, OfflinePlayer target, String fallbackName, String reason)

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

引数

  • CommandSender issuer
  • OfflinePlayer target
  • String fallbackName
  • String reason

throws

なし

主要な呼び出し順

sanitizeActorgetNameresolveTargetNameisBlankerrorgetUniqueIdsanitizeReasongetYellowToRedThreshold

clearCards

メソッドpublic
public boolean clearCards(CommandSender issuer, OfflinePlayer target, String fallbackName, String reason)

DB への問い合わせまたは更新処理を担当します。

引数

  • CommandSender issuer
  • OfflinePlayer target
  • String fallbackName
  • String reason

throws

なし

主要な呼び出し順

sanitizeActorgetNameresolveTargetNameisBlankgetUniqueIdtoStringsanitizeReasongetConnection

getStatus

メソッドpublic
public Optional<CardStatus> getStatus(OfflinePlayer target, String fallbackName)

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

引数

  • OfflinePlayer target
  • String fallbackName

throws

なし

主要な呼び出し順

getUniqueIdemptytoStringgetConnectionprepareStatementsetStringexecuteQuerynext

listActiveCards

メソッドpublic
public List<CardStatus> listActiveCards(int limit)

DB への問い合わせまたは更新処理を担当します。

引数

  • int limit

throws

なし

主要な呼び出し順

getYellowToRedThresholdgetConnectionprepareStatementsetIntmaxexecuteQuerynextmapStatusRow

getYellowToRedThreshold

メソッドpublic
public int getYellowToRedThreshold()

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

引数

  • 引数なし

throws

なし

主要な呼び出し順

maxgetConfiggetInt

getRedBanReason

メソッドpublic
public String getRedBanReason()

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

引数

  • 引数なし

throws

なし

主要な呼び出し順

sanitizeReasongetConfiggetString

upsertState

メソッドprivate
private void upsertState(Connection c, String uuid, String playerName, int yellowCount, String status, String reason, String issuedBy, String banReason) throws SQLException

DB への問い合わせまたは更新処理を担当します。

引数

  • Connection c
  • String uuid
  • String playerName
  • int yellowCount
  • String status
  • String reason
  • String issuedBy
  • String banReason

throws

SQLException

主要な呼び出し順

fromnowprepareStatementplayer_card_statesetStringsetIntsetTimestampequalsIgnoreCase

insertHistory

メソッドprivate
private void insertHistory(Connection c, String uuid, String playerName, String cardType, int yellowCountAfter, String reason, String issuedBy) throws SQLException

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

引数

  • Connection c
  • String uuid
  • String playerName
  • String cardType
  • int yellowCountAfter
  • String reason
  • String issuedBy

throws

SQLException

主要な呼び出し順

prepareStatementplayer_card_historysetStringsetIntexecuteUpdate

selectStatusForUpdate

メソッドprivate
private CardStatus selectStatusForUpdate(Connection c, String uuid) throws SQLException

DB への問い合わせまたは更新処理を担当します。

引数

  • Connection c
  • String uuid

throws

SQLException

主要な呼び出し順

prepareStatementsetStringexecuteQuerynextmapStatusRow

mapStatusRow

メソッドprivate
private CardStatus mapStatusRow(ResultSet rs) throws SQLException

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

引数

  • ResultSet rs

throws

SQLException

主要な呼び出し順

getTimestampgetStringgetInttoInstant

scheduleBan

メソッドprivate
private void scheduleBan(UUID uuid, String targetName, String issuerName)

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

引数

  • UUID uuid
  • String targetName
  • String issuerName

throws

なし

主要な呼び出し順

getSchedulerrunTaskgetOfflinePlayergetNameisBlankgetRedBanReasongetBanListaddBan

resolveTargetName

メソッドprivate
private String resolveTargetName(OfflinePlayer target, String fallbackName)

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

引数

  • OfflinePlayer target
  • String fallbackName

throws

なし

主要な呼び出し順

getNameisBlanktrimlengthsubstring

sanitizeReason

メソッドprivate
private String sanitizeReason(String reason)

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

引数

  • String reason

throws

なし

主要な呼び出し順

stripColorreplacetrimlengthsubstring

sanitizeActor

メソッドprivate
private String sanitizeActor(String actor)

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

引数

  • String actor

throws

なし

主要な呼び出し順

isBlankstripColorreplacetrimlengthsubstring

formatStatusLine

メソッドpublic
public String formatStatusLine(CardStatus status)

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

引数

  • CardStatus status

throws

なし

主要な呼び出し順

lastIssuedAtformatserverIdisBlankequalsIgnoreCasestatusbannedAtyellowCount

代表的な処理フロー

  1. ensureTables フロー
    ensureTables → getConnection → createStatement → executeUpdate → player_card_state → idx_player_card_state_status
    必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。
  2. ensureColumnDefinition フロー
    ensureColumnDefinition → createStatement → executeUpdate → getLogger → warning → getMessage
    必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。
  3. ensureUtf8mb4Table フロー
    ensureUtf8mb4Table → createStatement → executeUpdate → getLogger → warning → getMessage
    必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。
  4. ensurePlayerCardColumns フロー
    ensurePlayerCardColumns → ensureColumnDefinition
    必要なテーブル・状態・前提条件が揃っているかを確認し、不足分を補います。
  5. clearCards フロー
    clearCards → sanitizeActor → getName → resolveTargetName → isBlank → getUniqueId
    DB への問い合わせまたは更新処理を担当します。

外部との接点

Web ルート

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

SQL / テーブル

player_card_stateCURRENT_TIMESTAMPplayer_card_historycreateplayer_name

関連クラス

補足