Package ptolemy.kernel.util

Interface HierarchyListener

All Superinterfaces:

Nameable

All Known Implementing Classes:

AbstractInitializableAttribute, AbstractInitializableParameter, AnalyzeExceptionAttribute, AuthManager, CatchExceptionAttribute, ConstantPublisherPort, ConstraintMonitor.ConstraintMonitorAttributes, ExceptionEmailer, ExceptionManager, FilePortParameter, HlaManager, MirrorPortParameter, PortParameter, PublisherPort, PubSubPort, ShowTypes, SubscriberPort, SubscriptionAggregatorPort, SynchronizeToRealTime, TestExceptionAttribute

public interface HierarchyListener
extends Nameable

Interface for objects that need to be notified of hierarchy changes above them. Objects that implement this listener register with their container and will be notified when certain significant events above them in the hierarchy occur. In particular:

• if the container of any object above changes;
• if any object changes from an instance to a class or vice versa; or
• if any object changes from opaque to transparent or vice versa (acquires or loses a Director).

In each case, two methods will be called on the object implementing this interface: first, hierarchyWillChange() is called, notifying the object that the hierarchy is about to change; then hierarchyChanged() is called, notifying the object that the hierarchy has changed. The notified object can prevent changes by throwing an exception when the first method is called.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Edward A. Lee

Pt.AcceptedRating:

Red (eal )

Pt.ProposedRating:

Yellow (eal)

Method Summary

Modifier and Type	Method	Description
void	hierarchyChanged()	Notify this object that the containment hierarchy above it has changed.
void	hierarchyWillChange()	Notify this object that the containment hierarchy above it will be changed.

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Method Detail

hierarchyChanged

void hierarchyChanged()
               throws IllegalActionException

Notify this object that the containment hierarchy above it has changed.

Throws:

IllegalActionException - If the change is not acceptable.

hierarchyWillChange

void hierarchyWillChange()
                  throws IllegalActionException

Notify this object that the containment hierarchy above it will be changed.

Throws:

IllegalActionException - If the change is not acceptable.