com.tplan.robot.util

Interface DescriptionProvider

All Known Implementing Classes:

FileSearchRunnable

public interface DescriptionProvider

Declares method of an object able to generate description. This is generally used in conjunction with the Measurable interface to show description of the progress in the GUI.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Method Summary

Modifier and Type	Method and Description
String	getProgressDescription() Get description.

Method Detail

getProgressDescription

String getProgressDescription()

Get description. As consumers of the description are expected to call this method multiple times over a time period, the description may change depending on the internal state of the implementing object, for example to describe the progress or the currently performed task.

Returns:

description.