public class Observable extends Object
This class represents an observable object, or "data" in the model-view paradigm. It can be subclassed to represent an object that the application wants to have observed.
An observable object can have one or more observers. An observer may be any object that implements interface Observer
. After an observable instance changes, an application calling the Observable
's notifyObservers
method causes all of its observers to be notified of the change by a call to their update
method.
The order in which notifications will be delivered is unspecified. The default implementation provided in the Observable class will notify Observers in the order in which they registered interest, but subclasses may change this order, use no guaranteed order, deliver notifications on separate threads, or may guarantee that their subclass follows this order, as they choose.
Note that this notification mechanism has nothing to do with threads and is completely separate from the wait
and notify
mechanism of class Object
.
When an observable object is newly created, its set of observers is empty. Two observers are considered the same if and only if the equals
method returns true for them.
notifyObservers()
, notifyObservers(java.lang.Object)
, Observer
, Observer.update(java.util.Observable, java.lang.Object)
public Observable()
Construct an Observable with zero Observers.
public void addObserver(Observer o)
Adds an observer to the set of observers for this object, provided that it is not the same as some observer already in the set. The order in which notifications will be delivered to multiple observers is not specified. See the class comment.
o
- an observer to be added.NullPointerException
- if the parameter o is null.public void deleteObserver(Observer o)
Deletes an observer from the set of observers of this object. Passing null
to this method will have no effect.
o
- the observer to be deleted.public void notifyObservers()
If this object has changed, as indicated by the hasChanged
method, then notify all of its observers and then call the clearChanged
method to indicate that this object has no longer changed.
Each observer has its update
method called with two arguments: this observable object and null
. In other words, this method is equivalent to:
notifyObservers(null)
public void notifyObservers(Object arg)
If this object has changed, as indicated by the hasChanged
method, then notify all of its observers and then call the clearChanged
method to indicate that this object has no longer changed.
Each observer has its update
method called with two arguments: this observable object and the arg
argument.
arg
- any object.clearChanged()
, hasChanged()
, Observer.update(java.util.Observable, java.lang.Object)
public void deleteObservers()
Clears the observer list so that this object no longer has any observers.
protected void setChanged()
Marks this Observable
object as having been changed; the hasChanged
method will now return true
.
protected void clearChanged()
Indicates that this object has no longer changed, or that it has already notified all of its observers of its most recent change, so that the hasChanged
method will now return false
. This method is called automatically by the notifyObservers
methods.
public boolean hasChanged()
Tests if this object has changed.
true
if and only if the setChanged
method has been called more recently than the clearChanged
method on this object; false
otherwise.clearChanged()
, setChanged()
public int countObservers()
Returns the number of observers of this Observable
object.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.