Package com.ultikits.ultitools.utils

Class PluginInstallUtils.UninstallReport

java.lang.Object

com.ultikits.ultitools.utils.PluginInstallUtils.UninstallReport

Enclosing class:

PluginInstallUtils

@Internal
public static final class PluginInstallUtils.UninstallReport
extends Object

What an uninstall did, and what it could not determine.

The entries it could not classify are not failures -- an entry nothing can be read from must never stop an uninstall -- but they are not nothing either: if one of them is a copy of this module, it loads again at the next start. Reporting them is what lets the operator decide, which is not the same as guessing on their behalf.

Field Summary

Fields

Modifier and Type	Field	Description
private final List<String>	deleted
private final boolean	jarsDeleted
private final List<String>	undetermined

Constructor Summary

Constructors

Modifier	Constructor	Description
private	UninstallReport(boolean jarsDeleted, List<String> undetermined, List<String> deleted)

Method Summary

Modifier and Type	Method	Description
List<String>	deletedFiles()	The files this uninstall deleted, by absolute path.
boolean	jarsDeleted()
static PluginInstallUtils.UninstallReport	of(boolean jarsDeleted, List<String> undetermined)
static PluginInstallUtils.UninstallReport	of(boolean jarsDeleted, List<String> undetermined, List<String> deleted)
List<String>	undeterminedEntries()

Methods inherited from class java.lang.Object

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

Field Details

jarsDeleted

private final boolean jarsDeleted

undetermined

private final List<String> undetermined

deleted

private final List<String> deleted

Constructor Details

UninstallReport

private UninstallReport(boolean jarsDeleted,
 List<String> undetermined,
 List<String> deleted)

Method Details

of

public static PluginInstallUtils.UninstallReport of(boolean jarsDeleted,
 List<String> undetermined)

Parameters:

jarsDeleted - whether every entry identified as this module's was deleted

undetermined - the absolute paths of the entries nothing could identify

Returns:

the report, with no files named as deleted

of

public static PluginInstallUtils.UninstallReport of(boolean jarsDeleted,
 List<String> undetermined,
 List<String> deleted)

Parameters:

jarsDeleted - whether every entry identified as this module's was deleted

undetermined - the absolute paths of the entries nothing could identify

deleted - the absolute paths of the entries that were deleted

Returns:

the report

jarsDeleted

public boolean jarsDeleted()

Returns:

whether every entry identified as this module's was deleted

undeterminedEntries

public List<String> undeterminedEntries()

Returns:

the absolute paths of the entries whose identity could not be determined

deletedFiles

public List<String> deletedFiles()

The files this uninstall deleted, by absolute path.

Named so the operator can see what was removed: every other outcome names paths, and a success that named none is what made a deletion outside the operator's request invisible (gate 1, IN-12 and BL-02).

Returns:

the deleted paths