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

A

addMessage(DFFeedback.Type, Object, Throwable) - Method in class com.im.commons.progress.ConsoleFeedback

addMessage(DFFeedback.Type, Object, Throwable) - Method in interface com.im.commons.progress.DFFeedback

Adds a message to the feedback.

addPropertyChangeListener(PropertyChangeListener) - Method in class com.im.commons.progress.ConsoleFeedback

addPropertyChangeListener(PropertyChangeListener) - Method in interface com.im.commons.progress.DFFeedback

addPropertyChangeListener(PropertyChangeListener) - Method in interface com.im.commons.progress.DFLockable

Register to listen to DFLockable.PROP_LOCKED property change.

addPropertyChangeListener(PropertyChangeListener) - Method in class com.im.commons.progress.SimpleLockable

AlreadyLockedException - Exception in com.im.commons.progress

This exception is thrown from a DFLockable.obtainLock(java.lang.String) when the object is already locked.

AlreadyLockedException(DFLockable, String, Throwable) - Constructor for exception com.im.commons.progress.AlreadyLockedException

Creates a new instance of AlreadyLockedException

AlreadyLockedException(DFLockable, String, Throwable, boolean) - Constructor for exception com.im.commons.progress.AlreadyLockedException

Creates a new instance of AlreadyLockedException

B

BackgroundRunner - Class in com.im.commons.progress

The utility class which supports running of some task in request processor and after finishing transfer the code flow to AWT event dispatching thread.

BackgroundRunner() - Constructor for class com.im.commons.progress.BackgroundRunner

BackgroundRunner(int) - Constructor for class com.im.commons.progress.BackgroundRunner

BackgroundRunner.BackgroundTask - Class in com.im.commons.progress

Implementation of Task backed by ExecutorService provided by BackgroundTask or its descendant classes.

BackgroundTask(BackgroundRunner) - Constructor for class com.im.commons.progress.BackgroundRunner.BackgroundTask

BackgroundTask(BackgroundRunner, int) - Constructor for class com.im.commons.progress.BackgroundRunner.BackgroundTask

C

cancel() - Method in class com.im.commons.progress.BackgroundRunner.BackgroundTask

cancel() - Method in class com.im.commons.progress.ConsoleFeedback

cancel() - Method in interface com.im.commons.progress.Task

Removes the task from the queue.

CancelException - Exception in com.im.commons.progress

Exceptional return code from the operation.

CancelException() - Constructor for exception com.im.commons.progress.CancelException

CancelException(String) - Constructor for exception com.im.commons.progress.CancelException

checkLock(DFLock) - Method in interface com.im.commons.progress.DFLockable

Checks whether the lock belongs to this lockable.

checkLock(DFLock) - Method in class com.im.commons.progress.SimpleLockable

com.im.commons.progress - package com.im.commons.progress

ConsoleFeedback - Class in com.im.commons.progress

Implementation of DFFeedback which prints all messages to console or provided stream.

ConsoleFeedback() - Constructor for class com.im.commons.progress.ConsoleFeedback

ConsoleFeedback(PrintStream) - Constructor for class com.im.commons.progress.ConsoleFeedback

createDefaultEnvironmentRO(String, boolean) - Static method in class com.im.commons.progress.EnvUtils

Creates default environment for read only operations.

createDefaultEnvironmentRW(DFLock, String, boolean) - Static method in class com.im.commons.progress.EnvUtils

Creates default environment for read-write operations.

createFeedbackWithCancel(DFFeedback) - Static method in class com.im.commons.progress.EnvUtils

Creates a proxy implementation for given DFFeedback and returns its extension of EnvUtils.DFFeedbackWithCancel type.

createRO(String, boolean) - Method in interface com.im.commons.progress.EnvironmentsFactory

createRW(DFLock, String, boolean) - Method in interface com.im.commons.progress.EnvironmentsFactory

createRWFromRO(DFEnvironmentRO, DFLock) - Static method in class com.im.commons.progress.EnvUtils

Make RW environment from given RO by adding lock and delegating the rest of methods.

createSubTaskEnvironment(DFEnvironmentRO, String, int, int, int) - Static method in class com.im.commons.progress.EnvUtils

createSubTaskEnvironment(PropertyChangeEvent, String) - Static method in class com.im.commons.progress.EnvUtils

Creates sub-environment.

createTask() - Method in class com.im.commons.progress.BackgroundRunner

createTask() - Method in class com.im.commons.progress.UIBackgroundRunnerRW

D

DEV_NULL - Static variable in interface com.im.commons.progress.DFEnvironmentRO

Empty default implementation of DFEnvironmentRO.

DEV_NULL - Static variable in interface com.im.commons.progress.DFFeedback

"Empty device" - all feedback is ignored.

DFEnvironmentRO - Interface in com.im.commons.progress

Environment of time consuming read-only methods - methods, which don't modify data, but it is expected that they will take more time to perform.

DFEnvironmentRW - Interface in com.im.commons.progress

An extension of DFEnvironmentRO class which provides environment for read-only methods.

DFFeedback - Interface in com.im.commons.progress

Provides call backs for displaying progress and information as processes run in the DIF tier.

DFFeedback.Type - Enum in com.im.commons.progress

Types of messages to be used in DFFeedback.

DFLock - Interface in com.im.commons.progress

A lock that can be used to restrict access to a DIF object.

DFLockable - Interface in com.im.commons.progress

Most of DIF write methods (methods which modifies data or model somehow) use locking.

DFStatusDisplayer - Class in com.im.commons.progress

Simple wrapper around StatusLogger.

DFStatusDisplayer() - Constructor for class com.im.commons.progress.DFStatusDisplayer

E

EnvironmentsFactory - Interface in com.im.commons.progress

Any extension module can install own version of DFEnvironmentRX factory.

EnvUtils - Class in com.im.commons.progress

This class is used as factory for creating default implementation of DIF environments (DFEnvironmentRO and DFEnvironmentRW) and for creating environment for subtasks.

EnvUtils.DFFeedbackWithCancel - Interface in com.im.commons.progress

An extension of DFFeedback with ability to cancel the running task.

ERROR - com.im.commons.progress.DFFeedback.Type

This is usually printed as error message in Output panel (usually red font).

ErrorNotifier - Class in com.im.commons.progress

Opens user-friendly dialog with error.

ErrorNotifier.Notifier - Interface in com.im.commons.progress

F

failTask(Exception) - Method in class com.im.commons.progress.BackgroundRunner

Finishes the task with the failure report passed as a parameter.

finish() - Method in class com.im.commons.progress.ConsoleFeedback

finish() - Method in interface com.im.commons.progress.DFFeedback

Indicate the task is done.

G

getCreateLock() - Method in class com.im.commons.progress.BackgroundRunner

getDefault() - Static method in class com.im.commons.progress.DFStatusDisplayer

Finds implementation of status displayer.

getDelay() - Method in class com.im.commons.progress.BackgroundRunner

getEnvironment() - Method in class com.im.commons.progress.PropertyChangeEventWithEnv

getEnvironment() - Method in class com.im.commons.progress.UIBackgroundRunnerRO

getEnvironment() - Method in class com.im.commons.progress.UIBackgroundRunnerRW

getExecutorService() - Method in class com.im.commons.progress.BackgroundRunner

Which ScheduledExecutorService to use for running tasks.

getExecutorService() - Method in class com.im.commons.progress.UIBackgroundRunnerRW

We need single thread executor service per lockable.

getFeedback() - Method in interface com.im.commons.progress.DFEnvironmentRO

getId() - Method in class com.im.commons.progress.ConsoleFeedback

getId() - Method in interface com.im.commons.progress.DFFeedback

getLock() - Method in interface com.im.commons.progress.DFEnvironmentRW

getLockable() - Method in exception com.im.commons.progress.AlreadyLockedException

getLockedBy() - Method in exception com.im.commons.progress.AlreadyLockedException

The stack trace where the lockable was locked.

getMessagePrefix() - Method in class com.im.commons.progress.ConsoleFeedback

getReason() - Method in exception com.im.commons.progress.AlreadyLockedException

getReason() - Method in interface com.im.commons.progress.DFLock

getRootCause(Throwable) - Static method in class com.im.commons.progress.ErrorNotifier

Get the message of the root cause exception.

getTask() - Method in class com.im.commons.progress.BackgroundRunner

I

INFO - com.im.commons.progress.DFFeedback.Type

This is usually printed as standard message in Output panel.

interrupt() - Method in class com.im.commons.progress.BackgroundRunner

isCancelled() - Method in class com.im.commons.progress.ConsoleFeedback

isCancelled() - Method in interface com.im.commons.progress.DFFeedback

Return whether this operation was cancelled by user.

isFinished() - Method in class com.im.commons.progress.BackgroundRunner.BackgroundTask

isFinished() - Method in interface com.im.commons.progress.Task

Test whether the task has finished running.

isLocked() - Method in interface com.im.commons.progress.DFLockable

Is a valid lock held by someone already?

isLocked() - Method in class com.im.commons.progress.SimpleLockable

isLockedForever() - Method in exception com.im.commons.progress.AlreadyLockedException

Return true if lockable is locked forever, which typically means that user does not have appropriate access rights and so no changes are allowed.

isLockedForever() - Method in interface com.im.commons.progress.DFLockable

Is this lockable constantly locked? This can be used for lockables which are in readonly mode (e.g.

isLockedForever() - Method in class com.im.commons.progress.SimpleLockable

isValid() - Method in interface com.im.commons.progress.DFLock

When lock is released it become invalid and cannot be used more.

N

notifyUser(Throwable, String) - Method in interface com.im.commons.progress.ErrorNotifier.Notifier

notifyUser(Throwable, String) - Static method in class com.im.commons.progress.ErrorNotifier

Open an error dialog with user friendly message and possibility to see details (and in the future also sending error report).

O

obtainLock(String) - Method in interface com.im.commons.progress.DFLockable

Obtains the lock; fails with AlreadyLockedException if the object is already locked.

obtainLock(String) - Method in class com.im.commons.progress.SimpleLockable

P

phase1Cancelled(CancelException) - Method in class com.im.commons.progress.BackgroundRunner

phase1Cancelled(CancelException) - Method in class com.im.commons.progress.UIBackgroundRunnerRO

phase1Cancelled(CancelException) - Method in class com.im.commons.progress.UIBackgroundRunnerRW

phase1Exception(Exception) - Method in class com.im.commons.progress.BackgroundRunner

All subclasses must override this method and provide more user-friendly error notification.

phase1Exception(Exception) - Method in class com.im.commons.progress.UIBackgroundRunnerRO

phase1Exception(Exception) - Method in class com.im.commons.progress.UIBackgroundRunnerRW

phase1Finally() - Method in class com.im.commons.progress.BackgroundRunner

phase1FinallyInternal() - Method in class com.im.commons.progress.BackgroundRunner

phase1FinallyInternal() - Method in class com.im.commons.progress.UIBackgroundRunnerRO

phase1FinallyInternal() - Method in class com.im.commons.progress.UIBackgroundRunnerRW

phase1InRequestProcessor() - Method in class com.im.commons.progress.BackgroundRunner

This method code is executed in request processor.

phase2InAWT() - Method in class com.im.commons.progress.BackgroundRunner

This method code is executed in AWT thread after phase1 finishes.

processTheTask() - Method in class com.im.commons.progress.BackgroundRunner

progress(int) - Method in class com.im.commons.progress.ConsoleFeedback

progress(int) - Method in interface com.im.commons.progress.DFFeedback

Notify the user about completed work units.

PROGRESS_MESSAGE - com.im.commons.progress.DFFeedback.Type

Message which appears in progress detail.

PROGRESS_NAME - com.im.commons.progress.DFFeedback.Type

This code is used for renaming whole progress handle.

PROP_LOCKED - Static variable in interface com.im.commons.progress.DFLockable

Fired when lock managed by this lockable is acquired or released.

PROPERTY_CANCEL - Static variable in interface com.im.commons.progress.DFFeedback

Used by PropertyChangeListener for notifying about user-initiated cancel.

PropertyChangeEventWithEnv - Class in com.im.commons.progress

Property change event with an environment to be used for feedback and cancellation checking.

PropertyChangeEventWithEnv(Object, String, Object, Object, DFEnvironmentRO) - Constructor for class com.im.commons.progress.PropertyChangeEventWithEnv

R

release() - Method in interface com.im.commons.progress.DFLock

Releases the lock.

removePropertyChangeListener(PropertyChangeListener) - Method in class com.im.commons.progress.ConsoleFeedback

removePropertyChangeListener(PropertyChangeListener) - Method in interface com.im.commons.progress.DFFeedback

removePropertyChangeListener(PropertyChangeListener) - Method in interface com.im.commons.progress.DFLockable

Unregister to listen to DFLockable.PROP_LOCKED property change.

removePropertyChangeListener(PropertyChangeListener) - Method in class com.im.commons.progress.SimpleLockable

requestCancel() - Method in interface com.im.commons.progress.EnvUtils.DFFeedbackWithCancel

This method requests stopping the operation for which the feedback was used.

restart() - Method in class com.im.commons.progress.BackgroundRunner

S

schedule(int) - Method in class com.im.commons.progress.BackgroundRunner.BackgroundTask

schedule(int) - Method in interface com.im.commons.progress.Task

(Re-)schedules a task to run in the future.

setMessagePrefix(String) - Method in class com.im.commons.progress.ConsoleFeedback

setStatusText(String) - Method in class com.im.commons.progress.DFStatusDisplayer

setStatusText(String, int) - Method in class com.im.commons.progress.DFStatusDisplayer

SimpleLockable - Class in com.im.commons.progress

Lockable with minimal functionality to cover test-cases needs.

SimpleLockable() - Constructor for class com.im.commons.progress.SimpleLockable

start() - Method in class com.im.commons.progress.BackgroundRunner

Start runner.

STATUS_BAR_MESSAGE - com.im.commons.progress.DFFeedback.Type

This message is usually printed in global status bar of IJC.

switchToDeterminate(int) - Method in class com.im.commons.progress.ConsoleFeedback

switchToDeterminate(int) - Method in interface com.im.commons.progress.DFFeedback

Currently indeterminate task can be switched to show percentage completed.

switchToIndeterminate() - Method in class com.im.commons.progress.ConsoleFeedback

switchToIndeterminate() - Method in interface com.im.commons.progress.DFFeedback

Currently determinate task (with percentage or time estimate) can be switched to indeterminate mode.

T

Task - Interface in com.im.commons.progress

This interface allows control of tasks produced by BackgroundRunner.

thenRun(Runnable) - Method in class com.im.commons.progress.BackgroundRunner.BackgroundTask

thenRun(Runnable) - Method in interface com.im.commons.progress.Task

U

UIBackgroundRunnerRO - Class in com.im.commons.progress

UI extension of background runner - this class creates new DFEnvironmentRO using EnvUtils.

UIBackgroundRunnerRO(String, boolean) - Constructor for class com.im.commons.progress.UIBackgroundRunnerRO

UIBackgroundRunnerRW - Class in com.im.commons.progress

An extension of UIBackgroundRunnerRO which is able to lock the given DFLockable and use the lock in the background task.

UIBackgroundRunnerRW(DFLockable, String, boolean) - Constructor for class com.im.commons.progress.UIBackgroundRunnerRW

V

valueOf(String) - Static method in enum com.im.commons.progress.DFFeedback.Type

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

values() - Static method in enum com.im.commons.progress.DFFeedback.Type

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

W

waitFinished() - Method in class com.im.commons.progress.BackgroundRunner.BackgroundTask

waitFinished() - Method in interface com.im.commons.progress.Task

Wait until the task is finished.

waitFinished(long) - Method in class com.im.commons.progress.BackgroundRunner.BackgroundTask

waitFinished(long) - Method in interface com.im.commons.progress.Task

Wait until the task is finished, but only a given time.

WARNING - com.im.commons.progress.DFFeedback.Type

This is usually printed as warning message in Output panel.

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