org.jvnet.hk2.component
Interface RunLevelState<T>

All Known Implementing Classes:

DefaultRunLevelService

public interface RunLevelState<T>

Holds the state(s) for a particular RunLevelService.

Since:

3.1

Author:

Jeff Trent

Method Summary

java.lang.Integer	getCurrentRunLevel() The current run level state.
java.lang.Class<T>	getEnvironment() The environment value for this state.
java.lang.Integer	getPlannedRunLevel() The planned run level state.

Method Detail

getEnvironment

java.lang.Class<T> getEnvironment()

The environment value for this state.

Returns:

the class type used to uniquely identify the environment in context, or null representing the default environment.

getCurrentRunLevel

java.lang.Integer getCurrentRunLevel()

The current run level state. This represents the last run level successfully achieved by the underlying RunLevelService responsible for this environment.

Returns:

the current run level, or null if no run level has been been achieved.

getPlannedRunLevel

java.lang.Integer getPlannedRunLevel()

The planned run level state. If this value is different from current run level, this signifies movement of the underlying RunLevelService.

Returns:

the planned run level, or null if there is no planned level. This value is established by a call to RunLevelService.proceedTo(int).