org.kunlab.kpm.kpminfo.interfaces

Interface KPMInfoManager

All Known Implementing Classes:

KPMInfoManagerImpl

public interface KPMInfoManager

KPM情報ファイルを管理するクラスです。

Method Summary

Modifier and Type	Method and Description
@Nullable KPMInformationFile	getInfo(@NotNull org.bukkit.plugin.Plugin plugin) プラグインのKPM情報ファイルを取得します。
@Nullable KPMInformationFile	getInfo(@NotNull String pluginName) プラグインのKPM情報ファイルを取得します。
@Nullable KPMInformationFile	getOrLoadInfo(@NotNull org.bukkit.plugin.Plugin plugin) プラグインのKPM情報ファイルを取得するか読み込みます。
boolean	hasInfo(@NotNull Path pluginFile) プラグインが KPM情報ファイルを持っているかどうかを取得します。
boolean	hasInfo(@NotNull org.bukkit.plugin.Plugin plugin) プラグインが KPM情報ファイルを持っているかどうかを取得します。
@Nullable KPMInformationFile	loadInfo(@NotNull Path path, @NotNull org.bukkit.plugin.PluginDescriptionFile descriptionFile) KPM情報ファイルを読み込み追加します。
void	removeInfo(@NotNull org.bukkit.plugin.Plugin plugin) プラグインのKPM情報ファイルを削除します。

Method Detail

loadInfo

@Nullable
@Nullable KPMInformationFile loadInfo(@NotNull
                                                @NotNull Path path,
                                                @NotNull
                                                @NotNull org.bukkit.plugin.PluginDescriptionFile descriptionFile)
                                         throws FileNotFoundException,
                                                InvalidInformationFileException

KPM情報ファイルを読み込み追加します。

Parameters:

path - KPM情報ファイルのパス

descriptionFile - プラグインの説明ファイル

Returns:

読み込みに成功した場合はKPM情報ファイル、失敗した場合はnull

Throws:

InvalidInformationFileException - KPM情報ファイルが不正な場合

FileNotFoundException - KPM情報ファイルが見つからない場合

getInfo

@Nullable
@Nullable KPMInformationFile getInfo(@NotNull
                                               @NotNull org.bukkit.plugin.Plugin plugin)

プラグインのKPM情報ファイルを取得します。

Parameters:

plugin - プラグイン

Returns:

プラグインのKPM情報ファイル

getInfo

@Nullable
@Nullable KPMInformationFile getInfo(@NotNull
                                               @NotNull String pluginName)

プラグインのKPM情報ファイルを取得します。

Parameters:

pluginName - プラグイン名

Returns:

プラグインのKPM情報ファイル

getOrLoadInfo

@Nullable
@Nullable KPMInformationFile getOrLoadInfo(@NotNull
                                                     @NotNull org.bukkit.plugin.Plugin plugin)

プラグインのKPM情報ファイルを取得するか読み込みます。

Parameters:

plugin - プラグイン

Returns:

プラグインのKPM情報ファイル

hasInfo

boolean hasInfo(@NotNull
                @NotNull org.bukkit.plugin.Plugin plugin)

プラグインが KPM情報ファイルを持っているかどうかを取得します。

Parameters:

plugin - プラグイン名

Returns:

プラグインが KPM情報ファイルを持っているかどうか

hasInfo

boolean hasInfo(@NotNull
                @NotNull Path pluginFile)

プラグインが KPM情報ファイルを持っているかどうかを取得します。

Parameters:

pluginFile - プラグインのファイル

Returns:

プラグインが KPM情報ファイルを持っているかどうか

removeInfo

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

プラグインのKPM情報ファイルを削除します。

Parameters:

plugin - プラグイン