org.kunlab.kpm.meta.interfaces

Interface PluginMetaProvider

All Known Implementing Classes:

PluginMetaProviderImpl

public interface PluginMetaProvider

プラグインのメタデータを提供するクラスです。

Method Summary

Modifier and Type	Method and Description
void	buildDependencyTree(@NotNull org.bukkit.plugin.Plugin plugin) 依存関係ツリーを構築します。
void	buildDependencyTree(@NotNull String pluginName) 依存関係ツリーを構築します。
void	close() このクラスを破棄します。
int	countPlugins() 現在管理されているプラグインの数を取得します。
void	deleteFromDependencyTree(@NotNull String pluginName) 依存関係ツリーを間引きします。
List<String>	getAuthors(@NotNull String pluginName) プラグインの作者を取得します。
List<DependencyNode>	getDependedBy(@NotNull String pluginName) プラグインが依存(depend)されているプラグインのリストを取得します。
List<DependencyNode>	getDependOn(@NotNull String pluginName) プラグインが依存(depend)しているプラグインのリストを取得します。
InstallOperator	getInstalledBy(@NotNull String pluginName) プラグインが誰によってインストールされたかを取得します。
List<DependencyNode>	getLoadBefore(@NotNull String pluginName) プラグインを依存(load_before)しているプラグインのリストを取得します。 load_before は特殊な依存で, 依存しているプラグインを先に読み込むようにします。
List<DependencyNode>	getLoadBeforeBy(@NotNull String pluginName) プラグインが依存(load_before)されているプラグインのリストを取得します。 load_before は特殊な依存で, 依存しているプラグインを先に読み込むようにします。
@NotNull PluginMeta	getPluginMeta(@NotNull String pluginName) プラグインのメタデータを取得します。
@NotNull PluginMeta	getPluginMeta(@NotNull String pluginName, boolean includeDependencies, boolean includeAuthors) プラグインのメタデータを取得します。
@NotNull PluginMetaIterator	getPluginMetaIterator() PluginMeta のイテレータを取得します。
List<String>	getPluginsByAuthor(@NotNull String author) プラグインの作者からプラグインのリストを取得します。
List<DependencyNode>	getSoftDependedBy(@NotNull String pluginName) プラグインが依存(soft_depend)されているプラグインのリストを取得します。
List<DependencyNode>	getSoftDependOn(@NotNull String pluginName) プラグインが依存(soft_depend)しているプラグインのリストを取得します。
List<String>	getUnusedPlugins() 使われていない依存関係のリストを取得します。
boolean	isDependency(@NotNull String pluginName) プラグインが依存関係かどうかを取得します。 依存関係としてマークされている場合, 自動削除等の機能の対象になります。
boolean	isPluginMetaExists(@NotNull org.bukkit.plugin.Plugin pluginName) プラグインのメタデータが存在しているかどうかを返します。
boolean	isPluginMetaExists(@NotNull String pluginName) プラグインのメタデータが存在しているかどうかを返します。
void	removePluginMeta(@NotNull String pluginName) プラグインのメタデータを削除します。
void	removePluginMeta(String pluginName, Transaction transaction) プラグインのメタデータを削除します。
void	removePluginRelationalData(Connection connection, String pluginName) プラグインの依存データを削除します。
void	saveDependencyTree(@NotNull List<DependencyNode> dependencyNodes) 依存関係ツリーを保存します。
void	savePluginMeta(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull InstallOperator installedBy, long installedAt, @Nullable String resolveQuery, boolean isDependency) プラグインのメタデータを保存します。
void	savePluginMeta(@NotNull PluginMeta meta)
void	setDependencyFlag(@NotNull String pluginName, boolean isDependency) プラグインが依存関係かどうかを設定します。
void	updateResolveQuery(@NotNull String pluginName, @NotNull String query) プラグインの解決クエリを更新します。

Method Detail

close

void close()

このクラスを破棄します。

getDependOn

List<DependencyNode> getDependOn(@NotNull
                                 @NotNull String pluginName)

プラグインが依存(depend)しているプラグインのリストを取得します。

Parameters:

pluginName - プラグインの名前

Returns:

依存しているプラグインのリスト

getSoftDependOn

List<DependencyNode> getSoftDependOn(@NotNull
                                     @NotNull String pluginName)

プラグインが依存(soft_depend)しているプラグインのリストを取得します。

Parameters:

pluginName - プラグインの名前

Returns:

依存しているプラグインのリスト

getLoadBefore

List<DependencyNode> getLoadBefore(@NotNull
                                   @NotNull String pluginName)

プラグインを依存(load_before)しているプラグインのリストを取得します。 load_before は特殊な依存で, 依存しているプラグインを先に読み込むようにします。

Parameters:

pluginName - プラグインの名前

Returns:

依存しているプラグインのリスト

getDependedBy

List<DependencyNode> getDependedBy(@NotNull
                                   @NotNull String pluginName)

プラグインが依存(depend)されているプラグインのリストを取得します。

Parameters:

pluginName - プラグインの名前

Returns:

依存されているプラグインのリスト

getSoftDependedBy

List<DependencyNode> getSoftDependedBy(@NotNull
                                       @NotNull String pluginName)

プラグインが依存(soft_depend)されているプラグインのリストを取得します。

Parameters:

pluginName - プラグインの名前

Returns:

依存されているプラグインのリスト

getLoadBeforeBy

List<DependencyNode> getLoadBeforeBy(@NotNull
                                     @NotNull String pluginName)

プラグインが依存(load_before)されているプラグインのリストを取得します。 load_before は特殊な依存で, 依存しているプラグインを先に読み込むようにします。

Parameters:

pluginName - プラグインの名前

Returns:

依存されているプラグインのリスト

getAuthors

List<String> getAuthors(@NotNull
                        @NotNull String pluginName)

プラグインの作者を取得します。

Parameters:

pluginName - プラグインの名前

Returns:

プラグインの作者

getPluginsByAuthor

List<String> getPluginsByAuthor(@NotNull
                                @NotNull String author)

プラグインの作者からプラグインのリストを取得します。

Parameters:

author - プラグインの作者

Returns:

プラグインのリスト

getInstalledBy

InstallOperator getInstalledBy(@NotNull
                               @NotNull String pluginName)

プラグインが誰によってインストールされたかを取得します。

Parameters:

pluginName - プラグインの名前

Returns:

プラグインのインストール者

isDependency

boolean isDependency(@NotNull
                     @NotNull String pluginName)

プラグインが依存関係かどうかを取得します。 依存関係としてマークされている場合, 自動削除等の機能の対象になります。

Parameters:

pluginName - プラグインの名前

Returns:

依存関係かどうか

setDependencyFlag

void setDependencyFlag(@NotNull
                       @NotNull String pluginName,
                       boolean isDependency)

プラグインが依存関係かどうかを設定します。

Parameters:

pluginName - プラグインの名前

isDependency - 依存関係かどうか

updateResolveQuery

void updateResolveQuery(@NotNull
                        @NotNull String pluginName,
                        @NotNull
                        @NotNull String query)

プラグインの解決クエリを更新します。

Parameters:

pluginName - プラグインの名前

query - 解決クエリ

isPluginMetaExists

boolean isPluginMetaExists(@NotNull
                           @NotNull String pluginName)

プラグインのメタデータが存在しているかどうかを返します。

Parameters:

pluginName - プラグインの名前

Returns:

プラグインのメタデータが存在しているかどうか

isPluginMetaExists

boolean isPluginMetaExists(@NotNull
                           @NotNull org.bukkit.plugin.Plugin pluginName)

プラグインのメタデータが存在しているかどうかを返します。

Parameters:

pluginName - プラグイン

Returns:

プラグインのメタデータが存在しているかどうか

savePluginMeta

void savePluginMeta(@NotNull
                    @NotNull org.bukkit.plugin.Plugin plugin,
                    @NotNull
                    @NotNull InstallOperator installedBy,
                    long installedAt,
                    @Nullable
                    @Nullable String resolveQuery,
                    boolean isDependency)

プラグインのメタデータを保存します。

Parameters:

plugin - プラグイン

installedBy - プラグインのインストール者

installedAt - プラグインのインストール日時

resolveQuery - プラグインの解決クエリ

isDependency - プラグインが依存関係かどうか

savePluginMeta

void savePluginMeta(@NotNull
                    @NotNull PluginMeta meta)

removePluginMeta

void removePluginMeta(@NotNull
                      @NotNull String pluginName)

プラグインのメタデータを削除します。

Parameters:

pluginName - プラグインの名前

removePluginMeta

void removePluginMeta(String pluginName,
                      Transaction transaction)

プラグインのメタデータを削除します。

Parameters:

pluginName - プラグインの名前

transaction - 使用するトランザクション

removePluginRelationalData

void removePluginRelationalData(Connection connection,
                                String pluginName)
                         throws SQLException

プラグインの依存データを削除します。

Parameters:

connection - 使用するコネクション

pluginName - プラグインの名前

Throws:

SQLException

getPluginMeta

@NotNull
@NotNull PluginMeta getPluginMeta(@NotNull
                                           @NotNull String pluginName,
                                           boolean includeDependencies,
                                           boolean includeAuthors)

プラグインのメタデータを取得します。

Parameters:

pluginName - プラグインの名前

includeDependencies - 依存関係を含めるかどうか

Returns:

プラグインのメタデータ

getPluginMeta

@NotNull
@NotNull PluginMeta getPluginMeta(@NotNull
                                           @NotNull String pluginName)

プラグインのメタデータを取得します。

Parameters:

pluginName - プラグインの名前

Returns:

プラグインのメタデータ

saveDependencyTree

void saveDependencyTree(@NotNull
                        @NotNull List<DependencyNode> dependencyNodes)

依存関係ツリーを保存します。

Parameters:

dependencyNodes - 依存関係ツリー

buildDependencyTree

void buildDependencyTree(@NotNull
                         @NotNull org.bukkit.plugin.Plugin plugin)

依存関係ツリーを構築します。

Parameters:

plugin - プラグイン

buildDependencyTree

void buildDependencyTree(@NotNull
                         @NotNull String pluginName)

依存関係ツリーを構築します。

Parameters:

pluginName - プラグイン

deleteFromDependencyTree

void deleteFromDependencyTree(@NotNull
                              @NotNull String pluginName)

依存関係ツリーを間引きします。

Parameters:

pluginName - プラグインの名前

getPluginMetaIterator

@NotNull
@NotNull PluginMetaIterator getPluginMetaIterator()

PluginMeta のイテレータを取得します。

Returns:

PluginMeta のイテレータ

countPlugins

int countPlugins()

現在管理されているプラグインの数を取得します。

Returns:

現在管理されているプラグインの数

getUnusedPlugins

List<String> getUnusedPlugins()

使われていない依存関係のリストを取得します。

(プラグインが依存関係であるかどうかは、plugin_meta.is_dependencyを使用して確認できます) 関係はdependency_treeテーブルに格納されています。

例：サーバにインストールされているプラグイン： PluginAは依存関係 PluginBは依存関係 PluginCは依存関係ではない

例1：

• PluginAはPluginBに依存している
• PluginBとPluginCの間には依存関係はない

この場合、このメソッドはPluginAとPluginBを返します。 なぜなら、PluginBはPluginAによって使用されていますが、PluginAはどのプラグインにも使用されていないからです。

例2：

• PluginCはPluginAに依存している
• PluginAはPluginBに依存している

この場合、このメソッドはどのプラグインも返しません。 なぜなら、PluginAはPluginCによって使用されていますが、PluginCは依存関係ではなく、サーバがこのプラグインを使用しているためです。

Returns:

使用されていないプラグインのリスト