A B C D E G H I L N O P R S T U V W
All Classes All Packages

A

AbstractProgressMonitor - Class in io.github.duckasteroid.progress.base

An abstract base class for monitors.

AbstractProgressMonitor(int, String) - Constructor for class io.github.duckasteroid.progress.base.AbstractProgressMonitor

addListener(ProgressMonitorListener) - Static method in class io.github.duckasteroid.progress.ProgressMonitorFactory

addProgressMonitorListener(ProgressMonitorListener) - Method in class io.github.duckasteroid.progress.base.BaseProgressMonitor

appendActive(List<ProgressMonitor>) - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

Recursive implementation behind BaseProgressMonitor.getAllActive().

B

BaseProgressMonitor - Class in io.github.duckasteroid.progress.base

A root implementation of the progress monitor interface.

BaseProgressMonitor() - Constructor for class io.github.duckasteroid.progress.base.BaseProgressMonitor

BaseProgressMonitor(long) - Constructor for class io.github.duckasteroid.progress.base.BaseProgressMonitor

BaseProgressMonitor(String) - Constructor for class io.github.duckasteroid.progress.base.BaseProgressMonitor

BaseProgressMonitor(String, long) - Constructor for class io.github.duckasteroid.progress.base.BaseProgressMonitor

BaseProgressMonitor(String, long, Collection<ProgressMonitorListener>) - Constructor for class io.github.duckasteroid.progress.base.BaseProgressMonitor

Create a new progress monitor.

C

cancelled - Variable in class io.github.duckasteroid.progress.base.BaseProgressMonitor

Has cancellation been requested.

CANCELLED - io.github.duckasteroid.progress.base.event.ProgressUpdateType

Progress cancelled.

childId - Variable in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

the next ID for a sub task.

children - Variable in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

a collection of the active children of this monitor.

clearListeners() - Static method in class io.github.duckasteroid.progress.ProgressMonitorFactory

compareTo(ProgressMonitor) - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

Gives an order to this and derived classes.

Configuration - Class in io.github.duckasteroid.progress

Configuration class used by clients (and supporting libraries) to load statically configured monitoring.

Configuration(Properties) - Constructor for class io.github.duckasteroid.progress.Configuration

context - Variable in class io.github.duckasteroid.progress.base.SubTaskProgressMonitor

The context of this monitor.

createProgressMonitorListener(String) - Method in interface io.github.duckasteroid.progress.base.event.ProgressMonitorListenerFactory

Create a ProgressMonitorListener for the named progress.

D

done - Variable in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

flag to indicate the work is done.

done() - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

DONE - io.github.duckasteroid.progress.base.event.ProgressUpdateType

Progress done.

E

equals(Object) - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

equals(Object) - Method in class io.github.duckasteroid.progress.base.event.ProgressMonitorEvent

G

getAllActive() - Method in class io.github.duckasteroid.progress.base.BaseProgressMonitor

A list of all the active monitors in this monitor and all children that are active.

getBoolean(String, Boolean) - Method in class io.github.duckasteroid.progress.Configuration

getContext() - Method in class io.github.duckasteroid.progress.base.BaseProgressMonitor

Always returns an empty list.

getContext() - Method in class io.github.duckasteroid.progress.base.SubTaskProgressMonitor

getFractionDone() - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

getInstance() - Static method in class io.github.duckasteroid.progress.Configuration

getInteger(String, Integer) - Method in class io.github.duckasteroid.progress.Configuration

getLong(String, Long) - Method in class io.github.duckasteroid.progress.Configuration

getParent() - Method in class io.github.duckasteroid.progress.base.BaseProgressMonitor

Always returns null.

getParent() - Method in class io.github.duckasteroid.progress.base.SubTaskProgressMonitor

getRoot() - Method in class io.github.duckasteroid.progress.base.event.ProgressMonitorEvent

getSize() - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

getSource() - Method in class io.github.duckasteroid.progress.base.event.ProgressMonitorEvent

getStatus() - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

getString(String, String) - Method in class io.github.duckasteroid.progress.Configuration

getStringValue(String) - Method in class io.github.duckasteroid.progress.Configuration

getTaskName() - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

getType() - Method in class io.github.duckasteroid.progress.base.event.ProgressMonitorEvent

getUnit() - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

getValue(String, Function<String, T>, T) - Method in class io.github.duckasteroid.progress.Configuration

getWorkDone() - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

H

hashCode() - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

hashCode() - Method in class io.github.duckasteroid.progress.base.event.ProgressMonitorEvent

hasValueFor(String) - Method in class io.github.duckasteroid.progress.Configuration

I

id - Variable in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

The identity of this monitor (unique in the scope of it's parent).

io.github.duckasteroid.progress - package io.github.duckasteroid.progress

io.github.duckasteroid.progress.base - package io.github.duckasteroid.progress.base

This package contains basic implementations of the progress monitor interface with support for sub tasks.

io.github.duckasteroid.progress.base.event - package io.github.duckasteroid.progress.base.event

isCancelled() - Method in class io.github.duckasteroid.progress.base.BaseProgressMonitor

isCancelled() - Method in class io.github.duckasteroid.progress.base.SubTaskProgressMonitor

isDone() - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

L

listeners - Variable in class io.github.duckasteroid.progress.base.BaseProgressMonitor

A set of listeners.

logUpdate(ProgressMonitorEvent) - Method in interface io.github.duckasteroid.progress.base.event.ProgressMonitorListener

Called when the supplied progress monitor has an update.

N

newMonitor(String, long) - Static method in class io.github.duckasteroid.progress.ProgressMonitorFactory

Create a new progress monitor using system wide settings.

newSubTask(String) - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

newSubTask(String, long) - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

notifyListeners(ProgressMonitor, ProgressUpdateType) - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

Notify any listeners of an update.

notifyListeners(ProgressMonitor, ProgressUpdateType) - Method in class io.github.duckasteroid.progress.base.BaseProgressMonitor

notifyListeners(ProgressMonitor, ProgressUpdateType) - Method in class io.github.duckasteroid.progress.base.SubTaskProgressMonitor

O

onDone() - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

Called exactly once when this transitions to the done state.

onDone() - Method in class io.github.duckasteroid.progress.base.BaseProgressMonitor

onDone() - Method in class io.github.duckasteroid.progress.base.SubTaskProgressMonitor

P

parent - Variable in class io.github.duckasteroid.progress.base.SubTaskProgressMonitor

parent (supplied in constructor).

parse(String) - Static method in enum io.github.duckasteroid.progress.base.event.ProgressUpdateType

Parse the string form into an enum.

ProgressMonitorEvent - Class in io.github.duckasteroid.progress.base.event

A simple event class to transfer progress from a monitor to a listener.

ProgressMonitorEvent(BaseProgressMonitor, ProgressMonitor, ProgressUpdateType) - Constructor for class io.github.duckasteroid.progress.base.event.ProgressMonitorEvent

Create a new event.

ProgressMonitorFactory - Class in io.github.duckasteroid.progress

A factory for creating ProgressMonitor instances where we don't care which listeners we get.

ProgressMonitorFactory() - Constructor for class io.github.duckasteroid.progress.ProgressMonitorFactory

ProgressMonitorListener - Interface in io.github.duckasteroid.progress.base.event

An interface for objects that listen to a tree of progress monitors and get notified when they change work, status or are done.

ProgressMonitorListenerFactory - Interface in io.github.duckasteroid.progress.base.event

A factory for listeners that create new objects based on the name of the progress created.

ProgressUpdateType - Enum in io.github.duckasteroid.progress.base.event

R

removeListener(ProgressMonitorListener) - Static method in class io.github.duckasteroid.progress.ProgressMonitorFactory

removeProgressMonitorListener(ProgressMonitorListener) - Method in class io.github.duckasteroid.progress.base.BaseProgressMonitor

removeSubTask(SubTaskProgressMonitor) - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

resetListeners() - Static method in class io.github.duckasteroid.progress.ProgressMonitorFactory

S

setCancelled(boolean) - Method in class io.github.duckasteroid.progress.base.BaseProgressMonitor

setCancelled(boolean) - Method in class io.github.duckasteroid.progress.base.SubTaskProgressMonitor

setSize(long) - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

setStatus(String) - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

setUnit(String) - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

size - Variable in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

The size of this monitor in work units, the total work.

status - Variable in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

The last set value of AbstractProgressMonitor.setStatus(String).

STATUS - io.github.duckasteroid.progress.base.event.ProgressUpdateType

A status change.

SubTaskProgressMonitor - Class in io.github.duckasteroid.progress.base

A sub task progress monitor.

SubTaskProgressMonitor(AbstractProgressMonitor, int, long, String) - Constructor for class io.github.duckasteroid.progress.base.SubTaskProgressMonitor

Create a sub task for a given parent monitor.

T

taskName - Variable in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

The current task name.

toString() - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

toString() - Method in class io.github.duckasteroid.progress.base.event.ProgressMonitorEvent

totalParentWork - Variable in class io.github.duckasteroid.progress.base.SubTaskProgressMonitor

The amount of work that this monitor contributes to it's parent when done.

U

unit - Variable in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

The unit of work in this monitor (default empty).

updateWork(long, long, boolean) - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

Called whenever the work or size (or both) have changed.

V

valueOf(String) - Static method in enum io.github.duckasteroid.progress.base.event.ProgressUpdateType

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.github.duckasteroid.progress.base.event.ProgressUpdateType

Returns an array containing the constants of this enum type, in the order they are declared.

W

WORK - io.github.duckasteroid.progress.base.event.ProgressUpdateType

Work done (the most common event).

workDone - Variable in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

The amount of work currently done.

worked(long) - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

worked(long, String) - Method in class io.github.duckasteroid.progress.base.AbstractProgressMonitor

A B C D E G H I L N O P R S T U V W
All Classes All Packages