Package com.ultikits.ultitools.utils

Class ModuleFileTransactions.StageResult

java.lang.Object

com.ultikits.ultitools.utils.ModuleFileTransactions.StageResult

Enclosing class:

ModuleFileTransactions

public static final class ModuleFileTransactions.StageResult
extends Object

What ModuleFileTransactions.stageUpdate(java.lang.String, java.util.List<com.ultikits.ultitools.abstracts.UltiToolsPlugin>, java.util.function.Function<com.ultikits.ultitools.abstracts.UltiToolsPlugin, java.io.File>, com.ultikits.ultitools.utils.ModuleFileTransactions.Catalogue, com.ultikits.ultitools.utils.ModuleFileTransactions.Downloader) did.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ModuleFileTransactions.StageResult.Outcome	The outcome.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	moduleName
private final String	newVersion
private final String	oldVersion
private final ModuleFileTransactions.StageResult.Outcome	outcome
private final String	previousFailure
private final Object[]	reasonArgs
private final String	reasonKey

Constructor Summary

Constructors

Modifier	Constructor	Description
private	StageResult(ModuleFileTransactions.StageResult.Outcome outcome, String moduleName, String oldVersion, String newVersion, String previousFailure, String reasonKey, Object[] reasonArgs)

Method Summary

Modifier and Type	Method	Description
(package private) static ModuleFileTransactions.StageResult	failed(String previousFailure, String reasonKey, Object... reasonArgs)
String	getModuleName()
String	getNewVersion()
String	getOldVersion()
ModuleFileTransactions.StageResult.Outcome	getOutcome()
String	getPreviousFailure()	An earlier start's failed apply of this module -- file and error -- which the operator is told about before anything else, or null.
Object[]	getReasonArgs()
String	getReasonKey()
(package private) static ModuleFileTransactions.StageResult	of(ModuleFileTransactions.StageResult.Outcome outcome, String moduleName, String oldVersion, String newVersion, String previousFailure)

Methods inherited from class java.lang.Object

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

Field Details

outcome

private final ModuleFileTransactions.StageResult.Outcome outcome

moduleName

private final String moduleName

oldVersion

private final String oldVersion

newVersion

private final String newVersion

previousFailure

private final String previousFailure

reasonKey

private final String reasonKey

reasonArgs

private final Object[] reasonArgs

Constructor Details

StageResult

private StageResult(ModuleFileTransactions.StageResult.Outcome outcome,
 String moduleName,
 String oldVersion,
 String newVersion,
 String previousFailure,
 String reasonKey,
 Object[] reasonArgs)

Method Details

of

static ModuleFileTransactions.StageResult of(ModuleFileTransactions.StageResult.Outcome outcome,
 String moduleName,
 String oldVersion,
 String newVersion,
 String previousFailure)

failed

static ModuleFileTransactions.StageResult failed(String previousFailure,
 String reasonKey,
 Object... reasonArgs)

getOutcome

public ModuleFileTransactions.StageResult.Outcome getOutcome()

Returns:

the outcome

getModuleName

public String getModuleName()

Returns:

the module's runtime name, when known

getOldVersion

public String getOldVersion()

Returns:

the version that is loaded now, when known

getNewVersion

public String getNewVersion()

Returns:

the staged version, when known

getPreviousFailure

public String getPreviousFailure()

An earlier start's failed apply of this module -- file and error -- which the operator is told about before anything else, or null.

Returns:

the failure, or null

getReasonKey

public String getReasonKey()

Returns:

the catalogue key of the reason nothing was staged, or null

getReasonArgs

public Object[] getReasonArgs()

Returns:

the reason's format arguments