fulmine.distribution.events
Class ConnectionAvailableEvent

java.lang.Object
  extended by fulmine.event.AbstractEvent
      extended by fulmine.event.system.AbstractSystemEvent
          extended by fulmine.distribution.events.ConnectionAvailableEvent
All Implemented Interfaces:
IEvent, ISystemEvent, IAddressable, IDescriptor, Cloneable

public final class ConnectionAvailableEvent
extends AbstractSystemEvent

A system event raised by an IConnection implementation and includes the connection to the remote IFrameworkContext that is available for use.

Author:
Ramon Servadei

Constructor Summary
ConnectionAvailableEvent(IEventManager context, IConnection connection)
          Standard constructor to encapsulate the available connection to a remote IFrameworkContext
 
Method Summary
protected  String getAdditionalToString()
          Delegate method for subclasses to provide additional toString information.
<T extends IConnection>
T
getConnection()
          Get the connection to the remote IFrameworkContext
 String toDetailedString()
          Provides a formatted string describing this object in detail.
 String toIdentityString()
          Get a string that provides the identification for this object.
 
Methods inherited from class fulmine.event.system.AbstractSystemEvent
hideSourceFromToString
 
Methods inherited from class fulmine.event.AbstractEvent
clone, equals, getAddress, getDomain, getDrivingFrame, getFrame, getIdentity, getSource, getTriggerEvent, getType, hashCode, setAddress, setDrivingFrame, setFrame, setSource, setTriggerEvent, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface fulmine.event.IEvent
clone, getDrivingFrame, getFrame, getSource, getTriggerEvent, setTriggerEvent
 
Methods inherited from interface fulmine.IAddressable
getAddress, getDomain, getIdentity, getType
 

Constructor Detail

ConnectionAvailableEvent

public ConnectionAvailableEvent(IEventManager context,
                                IConnection connection)
Standard constructor to encapsulate the available connection to a remote IFrameworkContext

Parameters:
context - the context for event operations
connection - the available connection to a remote context
Method Detail

getConnection

public <T extends IConnection> T getConnection()
Get the connection to the remote IFrameworkContext

Type Parameters:
T - an IConnection type
Returns:
the connection to the remote context

toDetailedString

public String toDetailedString()
Description copied from interface: IDescriptor
Provides a formatted string describing this object in detail. This has the same or more information than the standard Object.toString() method.

Specified by:
toDetailedString in interface IDescriptor
Overrides:
toDetailedString in class AbstractEvent
Returns:
a formatted string describing this object in detail

toIdentityString

public String toIdentityString()
Description copied from interface: IDescriptor
Get a string that provides the identification for this object. This should have no more detail than the Object.toString() method.

Specified by:
toIdentityString in interface IDescriptor
Overrides:
toIdentityString in class AbstractEvent
Returns:
a string that provides the identification for this object

getAdditionalToString

protected String getAdditionalToString()
Description copied from class: AbstractEvent
Delegate method for subclasses to provide additional toString information. This should be a comma separated string, e.g. "one, two, three"

Overrides:
getAdditionalToString in class AbstractSystemEvent
Returns:
the additional toString information in comma separated format


Copyright © 2007-2009. All Rights Reserved.