Package net.solarnetwork.node.runtime

Class SimplePlatformTaskInfo

java.lang.Object

net.solarnetwork.node.runtime.SimplePlatformTaskInfo

All Implemented Interfaces:

PlatformService.PlatformTaskInfo

public class SimplePlatformTaskInfo
extends Object
implements PlatformService.PlatformTaskInfo

Simple implementation of PlatformService.PlatformTaskInfo.

Version:

1.0

Author:

matt

Constructor Summary

Constructors

Constructor	Description
SimplePlatformTaskInfo(String taskId, String title, String message, double percentComplete, boolean complete, boolean restartRequired)	Construct from values.
SimplePlatformTaskInfo(PlatformService.PlatformTaskStatus status, Locale locale)	Construct from a status and locale.

Method Summary

Modifier and Type	Method	Description
String	getMessage()	Get a message describing what the task is currently doing.
double	getPercentComplete()	Get the amount of work that has been completed, as a fractional percentage between 0 and 1.
String	getTaskId()	Get a unique task ID for this task.
String	getTitle()	Get a title of this task.
boolean	isComplete()	Get a flag that indicates if the task is complete.
boolean	isRestartRequired()	Get a flag that indicates if a system restart is required after the task completes.

Methods inherited from class java.lang.Object

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

Constructor Details

SimplePlatformTaskInfo

public SimplePlatformTaskInfo(String taskId,
 String title,
 String message,
 double percentComplete,
 boolean complete,
 boolean restartRequired)

Construct from values.

Parameters:

taskId - the task ID

title - the title

message - the message

percentComplete - the percent complete

complete - true if the task is complete

restartRequired - the restart required flag

SimplePlatformTaskInfo

public SimplePlatformTaskInfo(PlatformService.PlatformTaskStatus status,
 Locale locale)

Construct from a status and locale.

Parameters:

status - the status

locale - the desired locale

Method Details

getTaskId

public String getTaskId()

Description copied from interface: PlatformService.PlatformTaskInfo

Get a unique task ID for this task.

Specified by:

getTaskId in interface PlatformService.PlatformTaskInfo

Returns:

the unique ID

getTitle

public String getTitle()

Description copied from interface: PlatformService.PlatformTaskInfo

Get a title of this task.

Specified by:

getTitle in interface PlatformService.PlatformTaskInfo

Returns:

the title

getMessage

public String getMessage()

Description copied from interface: PlatformService.PlatformTaskInfo

Get a message describing what the task is currently doing.

Specified by:

getMessage in interface PlatformService.PlatformTaskInfo

Returns:

the message

getPercentComplete

public double getPercentComplete()

Description copied from interface: PlatformService.PlatformTaskInfo

Get the amount of work that has been completed, as a fractional percentage between 0 and 1.

Specified by:

getPercentComplete in interface PlatformService.PlatformTaskInfo

Returns:

the amount of work completed, or anything < 0 if not known

isComplete

public boolean isComplete()

Description copied from interface: PlatformService.PlatformTaskInfo

Get a flag that indicates if the task is complete.

Specified by:

isComplete in interface PlatformService.PlatformTaskInfo

Returns:

the complete flag

isRestartRequired

public boolean isRestartRequired()

Description copied from interface: PlatformService.PlatformTaskInfo

Get a flag that indicates if a system restart is required after the task completes.

Specified by:

isRestartRequired in interface PlatformService.PlatformTaskInfo

Returns:

a restart required flag