All Packages Class Hierarchy This Package Previous Next Index
Interface javax.infobus.InfoBusMember
- public interface InfoBusMember
All InfoBusMembers are required to implement a constrained property
called infoBus -- this interface guarantees the
presence of that property. The InfoBus attempts to set it when
a connection is requested by the Member, and the attempt may be vetoed if
the property has already been set by a builder tool.
An implementation of this interface is provided in the InfoBusMemberSupport
class.
- Version:
- $Revision: 1.12 $ $Date: 08 Mar 1998 22:55:28 $
- See Also:
- InfoBusMemberSupport
-
addInfoBusPropertyListener(PropertyChangeListener)
- Adds a PropertyChangeListener that will be alerted whenever the
InfoBusMember's setInfoBus method is called and not vetoed.
-
addInfoBusVetoableListener(VetoableChangeListener)
- Adds a VetoableChangeListener to the list of listeners that will
be alerted whenever the InfoBusMember's setInfoBus method is called.
-
getInfoBus()
- Returns the InfoBus which is currently assigned to the InfoBusMember's
InfoBus property.
-
removeInfoBusPropertyListener(PropertyChangeListener)
- Removes a PropertyChangeListener from the list of listeners
requesting notification of an InfoBus change.
-
removeInfoBusVetoableListener(VetoableChangeListener)
- Removes a VetoableChangeListener from the list of listeners that will
be alerted whenever the InfoBusMember's setInfoBus method is called.
-
setInfoBus(InfoBus)
- Sets the InfoBus object for this InfoBusMember, if not vetoed.
setInfoBus
public abstract void setInfoBus(InfoBus newInfoBus) throws PropertyVetoException
- Sets the InfoBus object for this InfoBusMember, if not vetoed.
When an InfoBusMember joins an InfoBus (via InfoBus.join),
the responding InfoBus uses this method to set the member's
InfoBus property to itself.
Whenever this method is called, the InfoBusMember should create a
PropertyChangeEvent and send it to all registered VetoableChangeListeners,
which gives a third party an opportunity to reject the change and throw the
PropertyVetoException.
When a setInfoBus is successful (not vetoed), the InfoBusMember must notify
its PropertyChangeListeners of the new value and MUST call the register()
method on the new InfoBus value to establish itself as a participant there.
- Parameters:
- newInfoBus - the InfoBus which will be assigned to the InfoBus property
if the action is not vetoed
- Throws: PropertyVetoException
- if one or more of the
VetoableChangeListeners reject the proposed change of InfoBus
getInfoBus
public abstract InfoBus getInfoBus()
- Returns the InfoBus which is currently assigned to the InfoBusMember's
InfoBus property.
- Returns:
- the current value of the InfoBus property
addInfoBusVetoableListener
public abstract void addInfoBusVetoableListener(VetoableChangeListener vcl)
- Adds a VetoableChangeListener to the list of listeners that will
be alerted whenever the InfoBusMember's setInfoBus method is called.
Any of these listeners can veto the setInfoBus action by
throwing a PropertyVetoException.
- Parameters:
- vcl - the VetoableChangeListener to be added
removeInfoBusVetoableListener
public abstract void removeInfoBusVetoableListener(VetoableChangeListener vcl)
- Removes a VetoableChangeListener from the list of listeners that will
be alerted whenever the InfoBusMember's setInfoBus method is called.
- Parameters:
- vcl - the VetoableChangeListener to be removed
addInfoBusPropertyListener
public abstract void addInfoBusPropertyListener(PropertyChangeListener pcl)
- Adds a PropertyChangeListener that will be alerted whenever the
InfoBusMember's setInfoBus method is called and not vetoed.
- Parameters:
- pcl - the PropertyChangeListener to be alerted
removeInfoBusPropertyListener
public abstract void removeInfoBusPropertyListener(PropertyChangeListener pcl)
- Removes a PropertyChangeListener from the list of listeners
requesting notification of an InfoBus change.
- Parameters:
- pcl - the PropertyChangeListener to be removed
All Packages Class Hierarchy This Package Previous Next Index