org.jboss.forge.shell.events
Class Shutdown

java.lang.Object
  org.jboss.forge.shell.events.Shutdown

public final class Shutdown
extends Object

Fired as a signal to the shell that it should shut down now.

For example:

@Inject Event<Shutdown> shutdown;
...
shutdown.fire(new Shutdown(Shutdown.Status.NORMAL));

Author:

Lincoln Baxter, III

Nested Class Summary

static class

Shutdown.Status Status of the shell during shutdown.

Constructor Summary

Shutdown()
Defaults to Shutdown.Status.NORMAL

Shutdown(Shutdown.Status status)
Inform the shell to shut down with the given Shutdown.Status, now.

Method Summary

Shutdown.Status

getStatus() Get the status with which the shell should shut down.

Methods inherited from class java.lang.Object

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

Constructor Detail

Shutdown

public Shutdown()

Defaults to Shutdown.Status.NORMAL

Shutdown

public Shutdown(Shutdown.Status status)

Inform the shell to shut down with the given Shutdown.Status, now.

Method Detail

getStatus

public Shutdown.Status getStatus()

Get the status with which the shell should shut down.