com.im.commons.progress
Class EnvUtils

java.lang.Object
  com.im.commons.progress.EnvUtils

public class EnvUtils
extends Object

This class is used as factory for creating default implementation of DFEnvironment (DFFeedback) and for creating DFEnvironment for subtasks.

Constructor Summary

EnvUtils()

Method Summary

static DFEnvironmentRO	createDefaultEnvironmentRO(String progressName, boolean cancellable) Creates default environment for read only operations.
static DFEnvironmentRW	createDefaultEnvironmentRW(DFLock lock, String progressName, boolean cancellable) Creates default environment for read-write operations
static DFEnvironmentRW	createRWFromRO(DFEnvironmentRO env, DFLock lock) Make RW environment from given RO by adding lock and delegating the rest of methods.
static DFEnvironmentRO	createSubTaskEnvironment(DFEnvironmentRO env, String subTaskName, int masterWorkunitFrom, int masterWorkunitTo, int masterWorkunitTotal)

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvUtils

public EnvUtils()

Method Detail

createDefaultEnvironmentRO

public static DFEnvironmentRO createDefaultEnvironmentRO(String progressName,
                                                         boolean cancellable)

Creates default environment for read only operations.

Parameters:

progressName - The progress name

cancellable - The cancellable flag

Returns:

The default environment for read only operations

createDefaultEnvironmentRW

public static DFEnvironmentRW createDefaultEnvironmentRW(DFLock lock,
                                                         String progressName,
                                                         boolean cancellable)

Creates default environment for read-write operations

Parameters:

lock - The lock

progressName - The progress name

cancellable - The cancellable flag

Returns:

The default environment for read-write operations

createSubTaskEnvironment

public static DFEnvironmentRO createSubTaskEnvironment(DFEnvironmentRO env,
                                                       String subTaskName,
                                                       int masterWorkunitFrom,
                                                       int masterWorkunitTo,
                                                       int masterWorkunitTotal)

createRWFromRO

public static DFEnvironmentRW createRWFromRO(DFEnvironmentRO env,
                                             DFLock lock)

Make RW environment from given RO by adding lock and delegating the rest of methods. This method can be also used for replacing the current lock in some existing DFEnvironmentRW.

Parameters:

env - The read-only environment

lock - The lock

Returns:

The proxy for the given DFEnvironmentRO, all methods except getLock() delegate to the original env.