Fixes javadocs.

cusax-fix
Lyubomir Marinov 17 years ago
parent 78f031a743
commit c9eb1ec408

@ -9,34 +9,32 @@
import java.util.*;
/**
* Represents a source of <code>PropertyChangeEvent</code>s which notifies
* <code>PropertyChangeListener</code>s about changes in the values of
* properties.
*
* Represents a source of <tt>PropertyChangeEvent</tt>s which notifies
* <tt>PropertyChangeListener</tt>s about changes in the values of properties.
*
* @author Lubomir Marinov
*/
public class PropertyChangeNotifier
{
/**
* The list of <code>PropertyChangeListener</code>s interested in and
* notified about changes in the values of the properties of this
* <code>PropertyChangeNotifier</code>.
* The list of <tt>PropertyChangeListener</tt>s interested in and notified
* about changes in the values of the properties of this
* <tt>PropertyChangeNotifier</tt>.
*/
private final List<PropertyChangeListener> listeners
= new Vector<PropertyChangeListener>();
/**
* Adds a specific <code>PropertyChangeListener</code> to the list of
* listeners interested in and notified about changes in the values of the
* properties of this <code>PropertyChangeNotifier</code>.
* Adds a specific <tt>PropertyChangeListener</tt> to the list of listeners
* interested in and notified about changes in the values of the properties
* of this <tt>PropertyChangeNotifier</tt>.
*
* @param listener
* a <code>PropertyChangeListener</code> to be notified about
* changes in the values of the properties of this
* <code>PropertyChangeNotifier</code>. If the specified listener
* is already in the list of interested listeners (i.e. it has
* been previously added), it is not added again.
* @param listener a <tt>PropertyChangeListener</tt> to be notified about
* changes in the values of the properties of this
* <tt>PropertyChangeNotifier</tt>. If the specified listener is already in
* the list of interested listeners (i.e. it has been previously added), it
* is not added again.
*/
public void addPropertyChangeListener(PropertyChangeListener listener)
{
@ -49,14 +47,13 @@ public void addPropertyChangeListener(PropertyChangeListener listener)
}
/**
* Removes a specific <code>PropertyChangeListener</code> from the list of
* Removes a specific <tt>PropertyChangeListener</tt> from the list of
* listeners interested in and notified about changes in the values of the
* properties of this <code>PropertyChangeNotifer</code>.
* properties of this <tt>PropertyChangeNotifer</tt>.
*
* @param listener
* a <code>PropertyChangeListener</code> to no longer be notified
* about changes in the values of the properties of this
* <code>PropertyChangeNotifier</code>
* @param listener a <tt>PropertyChangeListener</tt> to no longer be
* notified about changes in the values of the properties of this
* <tt>PropertyChangeNotifier</tt>
*/
public void removePropertyChangeListener(PropertyChangeListener listener)
{
@ -68,22 +65,18 @@ public void removePropertyChangeListener(PropertyChangeListener listener)
}
/**
* Fires a new <code>PropertyChangeEvent</code> to the
* <code>PropertyChangeListener</code>s registered with this
* <code>PropertyChangeNotifier</code> in order to notify about a change in
* the value of a specific property which had its old value modified to a
* Fires a new <tt>PropertyChangeEvent</tt> to the
* <tt>PropertyChangeListener</tt>s registered with this
* <tt>PropertyChangeNotifier</tt> in order to notify about a change in the
* value of a specific property which had its old value modified to a
* specific new value.
*
* @param property
* the name of the property of this
* <code>PropertyChangeNotifier</code> which had its value
* changed
* @param oldValue
* the value of the property with the specified name before the
* change
* @param newValue
* the value of the property with the specified name after the
* change
* @param property the name of the property of this
* <tt>PropertyChangeNotifier</tt> which had its value changed
* @param oldValue the value of the property with the specified name before
* the change
* @param newValue the value of the property with the specified name after
* the change
*/
protected void firePropertyChange(
String property,
@ -111,28 +104,25 @@ protected void firePropertyChange(
}
/**
* Gets the <code>Object</code> to be reported as the source of a new
* <code>PropertyChangeEvent</code> which is to notify the
* <code>PropertyChangeListener</code>s registered with this
* <code>PropertyChangeNotifier</code> about the change in the value of a
* Gets the <tt>Object</tt> to be reported as the source of a new
* <tt>PropertyChangeEvent</tt> which is to notify the
* <tt>PropertyChangeListener</tt>s registered with this
* <tt>PropertyChangeNotifier</tt> about the change in the value of a
* property with a specific name from a specific old value to a specific new
* value.
*
* @param property
* the name of the property which had its value changed from the
* specified old value to the specified new value
* @param oldValue
* the value of the property with the specified name before the
* change
* @param newValue
* the value of the property with the specified name after the
* change
* @return the <code>Object</code> to be reported as the source of the new
* <code>PropertyChangeEvent</code> which is to notify the
* <code>PropertyChangeListener</code>s registered with this
* <code>PropertyChangeNotifier</code> about the change in the value
* of the property with the specified name from the specified old
* value to the specified new value
* @param property the name of the property which had its value changed from
* the specified old value to the specified new value
* @param oldValue the value of the property with the specified name before
* the change
* @param newValue the value of the property with the specified name after
* the change
* @return the <tt>Object</tt> to be reported as the source of the new
* <tt>PropertyChangeEvent</tt> which is to notify the
* <tt>PropertyChangeListener</tt>s registered with this
* <tt>PropertyChangeNotifier</tt> about the change in the value of the
* property with the specified name from the specified old value to the
* specified new value
*/
protected Object getPropertyChangeSource(
String property,

@ -7,25 +7,85 @@
package net.java.sip.communicator.util;
/**
* Represents a mechanism to easily add to a specific <tt>Object</tt> by means
* of composition support for firing <tt>PropertyChangeEvent</tt>s to
* <tt>PropertyChangeListener</tt>s.
*
* @author Lubomir Marinov
*/
public class PropertyChangeSupport
extends PropertyChangeNotifier
{
/**
* The <tt>Object</tt> to be reported as the source of the
* <tt>PropertyChangeEvent</tt>s fired by this instance.
*/
private final Object source;
/**
* Initializes a new <tt>PropertyChangeSupport</tt> which is to fire
* <tt>PropertyChangeEvent</tt>s and to report their source as a specific
* <tt>Object</tt>
*
* @param source the <tt>Object</tt> to be reported as the source of the
* <tt>PropertyChangeEvent</tt>s fired by the new instance
*/
public PropertyChangeSupport(Object source)
{
this.source = source;
}
public void firePropertyChange(String property, Object oldValue,
/**
* Fires a new <tt>PropertyChangeEvent</tt> to the
* <tt>PropertyChangeListener</tt>s registered with this
* <tt>PropertyChangeSupport</tt> in order to notify about a change in the
* value of a specific property which had its old value modified to a
* specific new value.
*
* @param property the name of the property of this
* <tt>PropertyChangeSupport</tt> which had its value changed
* @param oldValue the value of the property with the specified name before
* the change
* @param newValue the value of the property with the specified name after
* the change
* @see PropertyChangeNotifier#firePropertyChange(String, Object, Object)
*/
@Override
public void firePropertyChange(
String property,
Object oldValue,
Object newValue)
{
super.firePropertyChange(property, oldValue, newValue);
}
protected Object getPropertyChangeSource(String property, Object oldValue,
/**
* Gets the <tt>Object</tt> to be reported as the source of a new
* <tt>PropertyChangeEvent</tt> which is to notify the
* <tt>PropertyChangeListener</tt>s registered with this
* <tt>PropertyChangeSupport</tt> about the change in the value of a
* property with a specific name from a specific old value to a specific new
* value.
*
* @param property the name of the property which had its value changed from
* the specified old value to the specified new value
* @param oldValue the value of the property with the specified name before
* the change
* @param newValue the value of the property with the specified name after
* the change
* @return the <tt>Object</tt> to be reported as the source of the new
* <tt>PropertyChangeEvent</tt> which is to notify the
* <tt>PropertyChangeListener</tt>s registered with this
* <tt>PropertyChangeSupport</tt> about the change in the value of the
* property with the specified name from the specified old value to the
* specified new value
* @see PropertyChangeNotifier#getPropertyChangeSource(String, Object, Object)
*/
@Override
protected Object getPropertyChangeSource(
String property,
Object oldValue,
Object newValue)
{
return source;

Loading…
Cancel
Save