Errai 3.0.1-SNAPSHOT

org.jboss.errai.bus.client.api
Class BusLifecycleEvent

java.lang.Object
  extended by org.jboss.errai.bus.client.api.BusLifecycleEvent

public final class BusLifecycleEvent
extends Object

Represents the event that happens during a state transition in the ClientMessageBus lifecycle. Provides access to contextual information at the time of the event.

Author:
Jonathan Fuerth , Christian Sadilek
See Also:
BusLifecycleListener

Constructor Summary
BusLifecycleEvent(ClientMessageBus bus, TransportError reason)
          Creates a new lifecycle event with the given details.
 
Method Summary
 ClientMessageBus getBus()
          Returns the bus that this lifecycle event pertains to.
 TransportError getReason()
          The transport error that caused this lifecycle transition.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BusLifecycleEvent

public BusLifecycleEvent(ClientMessageBus bus,
                         TransportError reason)
Creates a new lifecycle event with the given details.

Parameters:
bus - The bus that this lifecycle event pertains to. Must not be null.
reason - The error that caused this lifecycle transition. Null is permitted, and means the transition was not caused by a transport error.
Method Detail

getBus

public ClientMessageBus getBus()
Returns the bus that this lifecycle event pertains to.

Returns:
The bus that this lifecycle event pertains to. Never null.

getReason

public TransportError getReason()
The transport error that caused this lifecycle transition.

Returns:
The transport error that caused this lifecycle transition. Returns null if the transition was not caused by a transport error.

Errai 3.0.1-SNAPSHOT

Copyright © 2013-2014 JBoss, a division of Red Hat. All Rights Reserved.