Package net.sf.basedb.util.extensions.manager

Class ProcessResults

java.lang.Object

net.sf.basedb.util.extensions.manager.ProcessResults

public class ProcessResults
extends Object

Class for collecting results from a scan for new/deleted/updated extensions.

Since:

3.0

Author:

Nicklas

Last modified

$Date: 2016-11-17 13:36:34 +0100 (to, 17 nov 2016) $

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProcessResults.FileResults	Scan results for a single XML or JAR file.

Field Summary

Fields

Modifier and Type	Field	Description
private long	endTime
private Map<ExtensionsFile,ProcessResults.FileResults>	fileResults
private boolean	hasError
private int	numErrorFiles
private Map<ExtensionsFile,ProcessResults.FileResults>	oldFileResults
private final long	startTime
private String	summary

Constructor Summary

Constructors

Constructor	Description
ProcessResults()	Create a new process results object.
ProcessResults(ProcessResults oldResults)	Create a new process results object, keeping information about previous results.

Method Summary

Modifier and Type	Method	Description
void	addErrorMessage(ExtensionsFile xtFile, String message)	Adds a detailed message inidcating a failed operation to a file.
void	addMessage(ExtensionsFile xtFile, String message)	Adds a detailed message indicating a successful operation to a file.
private void	addMessage(ExtensionsFile xtFile, String message, boolean error)
void	forgetOldResults(ExtensionsFile xtFile)	Forget old processing results for the given file.
List<ProcessResults.FileResults>	getAllResults()
long	getEndTime()	Get the end time of the scan as a millisecond value.
int	getNumErrorFiles()	The number of extension files that could not be completely loaded because of an error.
ProcessResults.FileResults	getResults(ExtensionsFile xtFile)	Get the results for a specific extensions file.
long	getStartTime()	Get the start time of the scan as a millisecond value.
String	getSummary()	Get a summary of the scan results as a textual description.
boolean	hasError()	Check if the scan was successful or not.
void	setEnded()	Set the end time of the scan.
void	setStatus(ExtensionsFile xtFile, String status)	Sets a short overall status message for an entire file.
void	setSummary(String summary)	Set a summary of the results.

Methods inherited from class java.lang.Object

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

Field Details

startTime

private final long startTime

fileResults

private Map<ExtensionsFile,ProcessResults.FileResults> fileResults

oldFileResults

private Map<ExtensionsFile,ProcessResults.FileResults> oldFileResults

hasError

private boolean hasError

numErrorFiles

private int numErrorFiles

endTime

private long endTime

summary

private String summary

Constructor Details

ProcessResults

public ProcessResults()

Create a new process results object.

ProcessResults

public ProcessResults(ProcessResults oldResults)

Create a new process results object, keeping information about previous results.

Since:

3.2.4

Method Details

getStartTime

public long getStartTime()

Get the start time of the scan as a millisecond value.

See Also:

• System.currentTimeMillis()

getEndTime

public long getEndTime()

Get the end time of the scan as a millisecond value.

See Also:

• System.currentTimeMillis()

setEnded

public void setEnded()

Set the end time of the scan.

getSummary

public String getSummary()

Get a summary of the scan results as a textual description.

setSummary

public void setSummary(String summary)

Set a summary of the results.

hasError

public boolean hasError()

Check if the scan was successful or not. For more detailed information use getResults(ExtensionsFile).

Returns:

TRUE if there was any problems, FALSE if everything was successful

getNumErrorFiles

public int getNumErrorFiles()

The number of extension files that could not be completely loaded because of an error.

getAllResults

public List<ProcessResults.FileResults> getAllResults()

getResults

public ProcessResults.FileResults getResults(ExtensionsFile xtFile)

Get the results for a specific extensions file. If no current results exists, old results are searched.

Parameters:

xtFile - The extensions file to get the results for

Returns:

A ProcessResults.FileResults object or null if the extensions file is not found

forgetOldResults

public void forgetOldResults(ExtensionsFile xtFile)

Forget old processing results for the given file. Should be called when an extension has been uninstalled,

Parameters:

xtFile - The extensions file to forget

Since:

3.2.4

setStatus

public void setStatus(ExtensionsFile xtFile,
 String status)

Sets a short overall status message for an entire file. Example: "Installed", "Failed", etc.

Parameters:

xtFile - The file to set the status on

status - The status message

See Also:

• addMessage(ExtensionsFile, String)
• addErrorMessage(ExtensionsFile, String)

addMessage

public void addMessage(ExtensionsFile xtFile,
 String message)

Adds a detailed message indicating a successful operation to a file.

Parameters:

xtFile - The file to add the message to

message - The message

See Also:

• addErrorMessage(ExtensionsFile, String)

addErrorMessage

public void addErrorMessage(ExtensionsFile xtFile,
 String message)

Adds a detailed message inidcating a failed operation to a file.

Parameters:

xtFile - The file to add the message to

message - The message

addMessage

private void addMessage(ExtensionsFile xtFile,
 String message,
 boolean error)