パッケージ com.lmt.lib.bldt

インタフェース GuiOption


  • public interface GuiOption
    難易度表ツール・難易度表更新画面の動作オプションを指定するI/Fです。

    LDTライブラリが提供する難易度表ツールの機能をカスタマイズするために使用されます。 当I/Fの全てのメソッドは規定の動作が定義されています。全ての動作を規定の動作としたい場合は DEFAULT を指定することができます。

    当I/Fの各メソッドは全てAWT EventQueueのディスパッチスレッドから実行されます。 特に理由がない限り各メソッドの処理は直ちに完了させるようにしてください。 そうしないと、OSによって「応答なしのアプリケーション」として判定される可能性があります。

    導入されたバージョン:
    0.4.0
    関連項目:
    DifficultyTables.guiBrowse(Window, ContentDatabase, GuiOption), DifficultyTables.guiUpdate(Window, ContentDatabase, String, GuiOption)
    • フィールドの概要

      フィールド 
      修飾子とタイプ フィールド 説明
      static GuiOption DEFAULT
      全ての動作をデフォルトの動作とする場合の動作オプション
    • メソッドの概要

      すべてのメソッド インスタンス・メソッド デフォルト・メソッド 
      修飾子とタイプ メソッド 説明
      default void closeLog​(OutputStream logStream)
      更新結果ログを閉じます。
      default OutputStream openLog()
      更新結果ログを開きます。
      default void showLog​(Window dialog)
      更新結果ログを表示します。
      default boolean supportOfficialSite()
      難易度表ツール上から、選択された難易度表の公式サイトへジャンプする機能を有効にするかどうかを決定します。
      default boolean supportShowLog()
      難易度表更新画面から、更新結果ログを表示する機能を有効にするかどうかを決定します。
      default boolean supportUpdate()
      難易度表ツール上から、選択された難易度表の更新処理をトリガーする機能を有効にするかどうかを決定します。
      default void updateResult​(Map<String,​UpdateResult> results)
      難易度表更新結果の通知です。
    • フィールドの詳細

      • DEFAULT

        static final GuiOption DEFAULT
        全ての動作をデフォルトの動作とする場合の動作オプション
    • メソッドの詳細

      • supportOfficialSite

        default boolean supportOfficialSite()
        難易度表ツール上から、選択された難易度表の公式サイトへジャンプする機能を有効にするかどうかを決定します。

        この機能を有効にすると難易度表ツールに「公式サイトボタン」が追加されます。 そのボタンをクリックすると選択中の難易度表の公式サイトを「規定のWebブラウザ」で表示します。

        難易度表更新画面ではこの値は参照されません。

        デフォルトではこの機能は「無効」に設定されています。

        戻り値:
        true:有効, false:無効
      • supportUpdate

        default boolean supportUpdate()
        難易度表ツール上から、選択された難易度表の更新処理をトリガーする機能を有効にするかどうかを決定します。

        この機能を有効にすると難易度表ツールに「更新ボタン」が追加されます。 そのボタンをクリックすると難易度表更新画面が表示され、更新対象の難易度表の更新が開始されます。

        難易度表更新画面ではこの値は参照されません。

        デフォルトではこの機能は「無効」に設定されています。

        戻り値:
        true:有効, false:無効
      • supportShowLog

        default boolean supportShowLog()
        難易度表更新画面から、更新結果ログを表示する機能を有効にするかどうかを決定します。

        この機能を有効にすると難易度表更新画面に「ログ表示ボタン」が追加されます。 そのボタンをクリックすると showLog(Window) が呼び出されますので、 そのタイミングで直前に openLog() で開いた更新結果ログを開く処理を実行してください。

        デフォルトではこの機能は「無効」に設定されています。

        戻り値:
        true:有効, false:無効
      • openLog

        default OutputStream openLog()
                              throws IOException
        更新結果ログを開きます。

        当メソッドが呼ばれたら難易度表更新画面での難易度表更新の結果を記録するための出力ストリームを返してください。 出力ストリームの内容は任意です(例:System.out)。nullを返すと更新結果ログは出力されません。

        画面に出力される更新結果ログは更新件数が多いと省略表示されますが、返された出力ストリームへは 全てのログを出力しようとします。

        デフォルトではnullを返します。

        戻り値:
        更新結果ログを出力するストリーム
        例外:
        IOException - 更新結果ログのオープンに失敗した
      • closeLog

        default void closeLog​(OutputStream logStream)
                       throws IOException
        更新結果ログを閉じます。

        難易度表更新処理が完了し、更新結果ログの出力が全て行われた後で実行されます。 supportShowLog() でfalseを返したり、openLog() でnullを返していた場合、 当メソッドは実行されません。

        デフォルトでは更新結果ログのストリームに対して close() を呼び出す実装になっています。 System.out等、close()を実行したくない場合は当メソッドをオーバーライドし、然るべき実装を行ってください。

        パラメータ:
        logStream - openLog() で開いた出力ストリーム
        例外:
        IOException - 更新結果ログのクローズに失敗した
      • showLog

        default void showLog​(Window dialog)
                      throws IOException
        更新結果ログを表示します。

        当メソッドは難易度表更新画面の「ログ表示ボタン」をクリックした時に実行されます。 当メソッドが実行された時に行うのは、「直前の更新結果をログ表示する」ことです。 ログ表示を画面上に表示する場合は引数の dialog を親ウィンドウとし、モーダルダイアログで表示してください。 外部アプリで表示したい場合は直前の openLog() で開いた更新結果ログを指定するようにしてください。

        デフォルト実装では何も行われません。更新結果ログ表示をサポートする場合は実装必須です。

        パラメータ:
        dialog - 難易度表更新画面のウィンドウを表すオブジェクト
        例外:
        IOException - 更新結果ログの表示に失敗した
      • updateResult

        default void updateResult​(Map<String,​UpdateResult> results)
        難易度表更新結果の通知です。

        当メソッドは難易度表更新画面で処理対象難易度表の更新処理が全て完了したタイミングで実行されます。 更新結果は、処理対象となった難易度表分が格納されています。キーは難易度表IDです。

        デフォルト実装では何も行われません。

        パラメータ:
        results - 更新処理の結果を格納するマップ