- java.lang.Object
-
- java.util.Observable
-
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
'snotifyObservers
method causes all of its observers to be notified of the change by a call to theirupdate
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 is 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.
- Since:
- JDK1.0
- See Also:
notifyObservers()
,notifyObservers(java.lang.Object)
,Observer
,Observer.update(java.util.Observable, java.lang.Object)
-
-
Constructor Summary
Constructors Constructor and Description Observable()
Construct an Observable with zero Observers.
-
Method Summary
Methods Modifier and Type Method and Description 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.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.int
countObservers()
Returns the number of observers of this Observable object.void
deleteObserver(Observer o)
Deletes an observer from the set of observers of this object.void
deleteObservers()
Clears the observer list so that this object no longer has any observers.boolean
hasChanged()
Tests if this object has changed.void
notifyObservers()
If this object has changed, as indicated by thehasChanged
method, then notify all of its observers and then call theclearChanged
method to indicate that this object has no longer changed.void
notifyObservers(Object arg)
If this object has changed, as indicated by thehasChanged
method, then notify all of its observers and then call theclearChanged
method to indicate that this object has no longer changed.protected void
setChanged()
Marks this Observable object as having been changed; the hasChanged method will now return true.
-
-
-
Method Detail
-
addObserver
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.- Parameters:
o
- an observer to be added.- Throws:
NullPointerException
- if the parameter o is null.
-
deleteObserver
public void deleteObserver(Observer o)
Deletes an observer from the set of observers of this object. Passingnull
to this method will have no effect.- Parameters:
o
- the observer to be deleted.
-
notifyObservers
public void notifyObservers()
If this object has changed, as indicated by thehasChanged
method, then notify all of its observers and then call theclearChanged
method to indicate that this object has no longer changed.Each observer has its
update
method called with two arguments: this observable object andnull
. In other words, this method is equivalent to:notifyObservers(null)
-
notifyObservers
public void notifyObservers(Object arg)
If this object has changed, as indicated by thehasChanged
method, then notify all of its observers and then call theclearChanged
method to indicate that this object has no longer changed.Each observer has its
update
method called with two arguments: this observable object and thearg
argument.- Parameters:
arg
- any object.- See Also:
clearChanged()
,hasChanged()
,Observer.update(java.util.Observable, java.lang.Object)
-
deleteObservers
public void deleteObservers()
Clears the observer list so that this object no longer has any observers.
-
setChanged
protected void setChanged()
Marks this Observable object as having been changed; the hasChanged method will now return true.
-
clearChanged
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 thenotifyObservers
methods.
-
hasChanged
public boolean hasChanged()
Tests if this object has changed.- Returns:
true
if and only if thesetChanged
method has been called more recently than theclearChanged
method on this object;false
otherwise.- See Also:
clearChanged()
,setChanged()
-
countObservers
public int countObservers()
Returns the number of observers of this Observable object.- Returns:
- the number of observers of this object.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/util/Observable.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.