net.kunmc.lab.kpm.meta

Class PluginMetaProvider

java.lang.Object

net.kunmc.lab.kpm.meta.PluginMetaProvider

public class PluginMetaProvider
extends Object

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

Constructor Summary

Constructors

Constructor and Description
PluginMetaProvider(@NotNull org.bukkit.plugin.Plugin plugin, @NotNull Path databasePath)

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 String pluginName) プラグインのメタデータが存在しているかどうかを返します。
void	removePluginMeta(@NotNull 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) プラグインの解決クエリを更新します。

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginMetaProvider

public PluginMetaProvider(@NotNull
                          @NotNull org.bukkit.plugin.Plugin plugin,
                          @NotNull
                          @NotNull Path databasePath)

Method Detail

close

public void close()

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

getDependOn

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

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

Parameters:

pluginName - プラグインの名前

Returns:

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

getSoftDependOn

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

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

Parameters:

pluginName - プラグインの名前

Returns:

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

getLoadBefore

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

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

Parameters:

pluginName - プラグインの名前

Returns:

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

getDependedBy

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

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

Parameters:

pluginName - プラグインの名前

Returns:

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

getSoftDependedBy

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

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

Parameters:

pluginName - プラグインの名前

Returns:

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

getLoadBeforeBy

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

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

Parameters:

pluginName - プラグインの名前

Returns:

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

getAuthors

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

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

Parameters:

pluginName - プラグインの名前

Returns:

プラグインの作者

getPluginsByAuthor

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

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

Parameters:

author - プラグインの作者

Returns:

プラグインのリスト

getInstalledBy

public InstallOperator getInstalledBy(@NotNull
                                      @NotNull String pluginName)

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

Parameters:

pluginName - プラグインの名前

Returns:

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

isDependency

public boolean isDependency(@NotNull
                            @NotNull String pluginName)

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

Parameters:

pluginName - プラグインの名前

Returns:

依存関係かどうか

setDependencyFlag

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

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

Parameters:

pluginName - プラグインの名前

isDependency - 依存関係かどうか

updateResolveQuery

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

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

Parameters:

pluginName - プラグインの名前

query - 解決クエリ

isPluginMetaExists

public boolean isPluginMetaExists(@NotNull
                                  @NotNull String pluginName)

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

Parameters:

pluginName - プラグインの名前

Returns:

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

savePluginMeta

public 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

public void savePluginMeta(@NotNull
                           @NotNull PluginMeta meta)

removePluginMeta

public void removePluginMeta(@NotNull
                             @NotNull String pluginName)

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

Parameters:

pluginName - プラグインの名前

getPluginMeta

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

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

Parameters:

pluginName - プラグインの名前

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

Returns:

プラグインのメタデータ

getPluginMeta

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

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

Parameters:

pluginName - プラグインの名前

Returns:

プラグインのメタデータ

saveDependencyTree

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

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

Parameters:

dependencyNodes - 依存関係ツリー

buildDependencyTree

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

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

Parameters:

plugin - プラグイン

buildDependencyTree

public void buildDependencyTree(@NotNull
                                @NotNull String pluginName)

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

Parameters:

pluginName - プラグイン

deleteFromDependencyTree

public void deleteFromDependencyTree(@NotNull
                                     @NotNull String pluginName)

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

Parameters:

pluginName - プラグインの名前

getPluginMetaIterator

@NotNull
public @NotNull PluginMetaIterator getPluginMetaIterator()

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

Returns:

PluginMeta のイテレータ

countPlugins

public int countPlugins()

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

Returns:

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

getUnusedPlugins

public 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:

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