Lifecycle (Net4j Utilities Documentation)

java.lang.Object
- org.eclipse.net4j.util.event.Notifier
- - org.eclipse.net4j.util.lifecycle.Lifecycle

All Implemented Interfaces:

INotifier, ILifecycle, ILifecycle.DeferrableActivation

Direct Known Subclasses:

FiniteStateMachine, ManagedContainer, Randomizer, RWLockManager, RWOLockManager, ShareableLifecycle, UserManager, UserManagerAuthenticator, Worker
```
public class Lifecycle
extends Notifier
implements ILifecycle, ILifecycle.DeferrableActivation
```
A default implementation of an entity with a lifecycle.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.eclipse.net4j.util.lifecycle.ILifecycle
  ILifecycle.DeferrableActivation

Field Summary

Fields
Modifier and Type Field and Description

static boolean USE_LABEL

Fields
Modifier and Type	Field and Description
`static boolean`	`USE_LABEL`

Constructor Summary

Constructors
Constructor and Description

Lifecycle()

Constructors
Constructor and Description
`Lifecycle()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`activate()`
`protected void`	`checkActive()`
`protected void`	`checkArg(boolean expr, String msg)`
`protected void`	`checkArg(Object handle, String handleName)`
`protected void`	`checkInactive()`
`protected void`	`checkNull(Object handle, String msg)`
`protected void`	`checkState(boolean expr, String msg)`
`protected void`	`checkState(Object handle, String handleName)`
`Exception`	`deactivate()`
`protected void`	`deferredActivate(boolean successful)`
`protected void`	`doActivate()`
`protected void`	`doAfterActivate()`
`protected void`	`doBeforeActivate()`
`protected void`	`doBeforeDeactivate()`
`protected void`	`doDeactivate()`
`protected void`	`dump()`
`LifecycleState`	`getLifecycleState()`
`boolean`	`isActive()`
`boolean`	`isDeferredActivation()`
`String`	`toString()`

Methods inherited from class org.eclipse.net4j.util.event.Notifier
addListener, fireEvent, fireEvent, fireEvent, fireThrowable, firstListenerAdded, getListeners, getNotificationService, hasListeners, lastListenerRemoved, removeListener

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.net4j.util.event.INotifier
addListener, getListeners, hasListeners, removeListener

Field Detail
- USE_LABEL
```
public static boolean USE_LABEL
```

Constructor Detail
- Lifecycle
```
public Lifecycle()
```
  Since:
  
  2.0

Method Detail

activate

public final void activate()
                    throws LifecycleException

Specified by:: activate in interface ILifecycle
Throws:: LifecycleException

deactivate
```
public final Exception deactivate()
```
Specified by:

deactivate in interface ILifecycle

getLifecycleState
```
public final LifecycleState getLifecycleState()
```
Specified by:

getLifecycleState in interface ILifecycle

Since:

3.0

isActive
```
public final boolean isActive()
```
Specified by:

isActive in interface ILifecycle

toString
```
public String toString()
```
Overrides:

toString in class Object

dump
```
protected final void dump()
```

checkActive
```
protected final void checkActive()
```

checkInactive
```
protected final void checkInactive()
```

checkNull

protected final void checkNull(Object handle,
             String msg)
                        throws NullPointerException

Throws:: NullPointerException

checkArg

protected final void checkArg(boolean expr,
            String msg)
                       throws IllegalArgumentException

Throws:: IllegalArgumentException

checkArg

protected final void checkArg(Object handle,
            String handleName)
                       throws IllegalArgumentException

Throws:: IllegalArgumentException

checkState

protected final void checkState(boolean expr,
              String msg)
                         throws IllegalStateException

Throws:: IllegalStateException

checkState

protected final void checkState(Object handle,
              String handleName)
                         throws IllegalStateException

Throws:: IllegalStateException

deferredActivate

protected final void deferredActivate(boolean successful)

Since:: 2.0

isDeferredActivation
```
public boolean isDeferredActivation()
```
Specified by:

isDeferredActivation in interface ILifecycle.DeferrableActivation

Since:

3.2

doBeforeActivate

protected void doBeforeActivate()
                         throws Exception

Throws:: Exception

doActivate

protected void doActivate()
                   throws Exception

Throws:: Exception

doAfterActivate

protected void doAfterActivate()
                        throws Exception

Throws:: Exception
Since:: 3.0

doBeforeDeactivate

protected void doBeforeDeactivate()
                           throws Exception

Throws:: Exception

doDeactivate

protected void doDeactivate()
                     throws Exception

Throws:: Exception

Class Lifecycle

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.lifecycle.ILifecycle

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.net4j.util.event.Notifier

Methods inherited from class java.lang.Object

Methods inherited from interface org.eclipse.net4j.util.event.INotifier

Field Detail

USE_LABEL

Constructor Detail

Lifecycle

Method Detail

activate

deactivate

getLifecycleState

isActive

toString

dump

checkActive

checkInactive

checkNull

checkArg

checkArg

checkState

checkState

deferredActivate

isDeferredActivation

doBeforeActivate

doActivate

doAfterActivate

doBeforeDeactivate

doDeactivate