Module org.refcodes.component

Package org.refcodes.component

Interface ProgressAccessor

All Known Subinterfaces:

ProgressAccessor.ProgressProperty

public interface ProgressAccessor

Provides an accessor for a progress property. Any component which wants to provide a progress information implements this interface. A value of zero ("0") indicates that there was no progress so far, a value of one ("1") indicates that the progress is 100%.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ProgressAccessor.ProgressMutator	Provides a mutator for a progress property.
static interface	ProgressAccessor.ProgressProperty	Provides a progress property.

Method Summary

Modifier and Type	Method	Description
float	getProgress()	The progress can be queried by this method.

Method Details

getProgress

float getProgress()

The progress can be queried by this method. A value of zero ("0") indicates that there was no progress so far, a value of one ("1") indicates that the progress is 100%.

Returns:

A value between zero ("0") and one ("1") determining the progress.