org.kunlab.kpm.installer

Class AbstractInstaller<A extends InstallerArgument,E extends Enum<E>,P extends Enum<P>>

java.lang.Object

org.kunlab.kpm.installer.AbstractInstaller<A,E,P>

Type Parameters:

A - インストーラの引数の型

E - インストールのタスクの列挙型

P - インストールのタスクの引数の型

All Implemented Interfaces:

PluginInstaller<A,E,P>

Direct Known Subclasses:

AliasUpdater, GarbageCleaner, PluginAutoRemover, PluginInstaller, PluginUninstaller, PluginUpgrader, TokenRegisterer

public abstract class AbstractInstaller<A extends InstallerArgument,E extends Enum<E>,P extends Enum<P>>
extends Object
implements PluginInstaller<A,E,P>

インストーラの基底クラスです。

Field Summary

Fields

Modifier and Type	Field and Description
protected InstallProgress<P,PluginInstaller<A,E,P>>	progress
protected KPMRegistry	registry
protected SignalHandleManager	signalHandler

Constructor Summary

Constructors

Constructor and Description
AbstractInstaller(@NotNull KPMRegistry registry, @NotNull SignalHandleManager signalHandler)

Method Summary

Modifier and Type	Method and Description
<T extends Enum<T>> InstallFailedInstallResult<P,T,?>	error(T reason) インストールが失敗したときの後始末を行います。
<T extends Enum<T>,S extends Enum<S>> InstallFailedInstallResult<P,T,S>	error(T reason, S taskStatus) インストールが失敗したときの後始末を行います。
protected abstract InstallResult<P>	execute(A arguments) インストーラを実行します。 このメソッドを直接呼び出すことは推奨されておらず、run(InstallerArgument)を使用してください。
protected boolean	isPluginIgnored(@NotNull String pluginName) プラグインが無視リストに入っているかどうかを取得します。
protected void	postSignal(@NotNull Signal signal) シグナルを送信します。
InstallResult<P>	run(A arguments) インストーラを実行します。 このメソッドは、内部でexecute(InstallerArgument)を呼び出します。
protected boolean	safeDelete(@NotNull File f) ファイルを安全に削除します。
protected <AA extends TaskArgument,R extends TaskResult<?,?>,TT extends InstallTask<AA,R>> @NotNull TaskChain<AA,P,R,R,TT>	submitter(P taskState, TT task) タスクのSubmitterを取得します。
protected @NotNull InstallResult<P>	success() インストールが成功したときの後始末を行います。
protected @NotNull InstallResult<P>	success(InstallResult<P> customResult) インストールが失敗したときの後始末を引数を指定して行います。

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kunlab.kpm.interfaces.installer.PluginInstaller

getProgress, getRegistry

Field Detail

registry

protected final KPMRegistry registry

progress

protected final InstallProgress<P extends Enum<P>,PluginInstaller<A extends InstallerArgument,E extends Enum<E>,P extends Enum<P>>> progress

signalHandler

protected final SignalHandleManager signalHandler

Constructor Detail

AbstractInstaller

public AbstractInstaller(@NotNull
                         @NotNull KPMRegistry registry,
                         @NotNull
                         @NotNull SignalHandleManager signalHandler)
                  throws IOException

Throws:

IOException

Method Detail

postSignal

protected void postSignal(@NotNull
                          @NotNull Signal signal)

シグナルを送信します。

Parameters:

signal - シグナル

execute

protected abstract InstallResult<P> execute(@NotNull
                                            A arguments)
                                     throws IOException,
                                            TaskFailedException

インストーラを実行します。 このメソッドを直接呼び出すことは推奨されておらず、run(InstallerArgument)を使用してください。

Parameters:

arguments - インストーラに渡す引数

Returns:

インストールの結果

Throws:

IOException - ファイルの読み書きに失敗した場合

TaskFailedException - インストールの途中でタスクが失敗した場合

See Also:

run(InstallerArgument)

run

public InstallResult<P> run(@NotNull
                            A arguments)

インストーラを実行します。 このメソッドは、内部でexecute(InstallerArgument)を呼び出します。

Specified by:

run in interface PluginInstaller<A extends InstallerArgument,E extends Enum<E>,P extends Enum<P>>

Parameters:

arguments - インストーラに渡す引数

Returns:

インストールの結果

See Also:

execute(InstallerArgument)

success

@NotNull
protected @NotNull InstallResult<P> success()

インストールが成功したときの後始末を行います。

Returns:

インストールの結果

success

@NotNull
protected @NotNull InstallResult<P> success(InstallResult<P> customResult)

インストールが失敗したときの後始末を引数を指定して行います。

Parameters:

customResult - インストールの結果

Returns:

インストールの結果

error

public <T extends Enum<T>> InstallFailedInstallResult<P,T,?> error(@NotNull
                                                                   T reason)

インストールが失敗したときの後始末を行います。

Type Parameters:

T - インストールのタスクの列挙型

Parameters:

reason - 失敗の理由

Returns:

インストールの結果

error

public <T extends Enum<T>,S extends Enum<S>> InstallFailedInstallResult<P,T,S> error(@Nullable
                                                                                     T reason,
                                                                                     @NotNull
                                                                                     S taskStatus)

インストールが失敗したときの後始末を行います。

Type Parameters:

T - インストールのタスクの列挙型

S - インストールのタスクの引数の型

Parameters:

reason - 失敗の理由

taskStatus - タスクの状態

Returns:

インストールの結果

submitter

@NotNull
protected <AA extends TaskArgument,R extends TaskResult<?,?>,TT extends InstallTask<AA,R>> @NotNull TaskChain<AA,P,R,R,TT> submitter(@NotNull
                                                                                                                                              P taskState,
                                                                                                                                              @NotNull
                                                                                                                                              TT task)

タスクのSubmitterを取得します。

Type Parameters:

AA - タスクの引数の型

R - タスクの戻り値の型

TT - タスクの列挙型

Parameters:

taskState - タスクの状態

task - タスク

Returns:

タスクのSubmitter

isPluginIgnored

protected boolean isPluginIgnored(@NotNull
                                  @NotNull String pluginName)

プラグインが無視リストに入っているかどうかを取得します。

Parameters:

pluginName - プラグインの名前

Returns:

プラグインが無視リストに入っているかどうか

safeDelete

protected boolean safeDelete(@NotNull
                             @NotNull File f)

ファイルを安全に削除します。

Parameters:

f - 削除するファイル

Returns:

削除に成功したかどうか