Spec-Zone.ru › OpenJDK 21

Класс PropertyChangeSupport

java.lang.Object
java.beans.PropertyChangeSupport
Все реализованные интерфейсы:
Serializable
Прямые известные подклассы:
SwingPropertyChangeSupport
public class PropertyChangeSupport extends Object implements Serializable
Этот утилитарный класс может использоваться компонентами, поддерживающими привязанные свойства. Он управляет списком слушателей и рассылает события PropertyChangeEvent им. Вы можете использовать экземпляр этого класса в качестве члена вашего компонента и делегировать ему работу с такими событиями. Слушатели PropertyChangeListener могут быть зарегистрированы для всех свойств или для свойства, указанного по имени.

Вот пример использования PropertyChangeSupport, который соответствует правилам и рекомендациям, изложенным в спецификации JavaBeans:

 public class MyBean {
     private final PropertyChangeSupport pcs = new PropertyChangeSupport(this);

     public void addPropertyChangeListener(PropertyChangeListener listener) {
         this.pcs.addPropertyChangeListener(listener);
     }

     public void removePropertyChangeListener(PropertyChangeListener listener) {
         this.pcs.removePropertyChangeListener(listener);
     }

     private String value;

     public String getValue() {
         return this.value;
     }

     public void setValue(String newValue) {
         String oldValue = this.value;
         this.value = newValue;
         this.pcs.firePropertyChange("value", oldValue, newValue);
     }

     [...]
 }
 

Экземпляр класса PropertyChangeSupport потокобезопасен.

Этот класс сериализуем. При сериализации он сохранит (и восстановит) всех сериализуемых слушателей. Несериализуемые слушатели будут пропущены во время сериализации.

С тех пор:
1.1
См. также:
  • VetoableChangeSupport
  • Сериализованная форма

Краткое описание конструкторов

Конструктор Описание
PropertyChangeSupport(Object sourceBean)
Создаёт объект PropertyChangeSupport.

Краткое описание методов

Модификатор и тип Метод Описание
void addPropertyChangeListener(PropertyChangeListener listener)
Добавляет PropertyChangeListener в список слушателей.
void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
Добавляет PropertyChangeListener для определённого свойства.
void fireIndexedPropertyChange(String propertyName, int index, boolean oldValue, boolean newValue)
Сообщает слушателям о событии обновления привязанного индексированного булевого свойства, зарегистрированных для отслеживания обновлений всех свойств или свойства с указанным именем.
void fireIndexedPropertyChange(String propertyName, int index, int oldValue, int newValue)
Сообщает слушателям о событии обновления привязанного индексированного целочисленного свойства, зарегистрированных для отслеживания обновлений всех свойств или свойства с указанным именем.
void fireIndexedPropertyChange(String propertyName, int index, Object oldValue, Object newValue)
Сообщает слушателям о событии обновления привязанного индексированного свойства, зарегистрированных для отслеживания обновлений всех свойств или свойства с указанным именем.
void firePropertyChange(PropertyChangeEvent event)
Отправляет событие изменения свойства слушателям, зарегистрированным для отслеживания обновлений всех свойств или свойства с указанным именем.
void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)
Сообщает слушателям об обновлении привязанного булевого свойства, зарегистрированных для отслеживания обновлений всех свойств или свойства с указанным именем.
void firePropertyChange(String propertyName, int oldValue, int newValue)
Сообщает слушателям об обновлении привязанного целочисленного свойства, зарегистрированных для отслеживания обновлений всех свойств или свойства с указанным именем.
void firePropertyChange(String propertyName, Object oldValue, Object newValue)
Сообщает слушателям об обновлении привязанного свойства, зарегистрированных для отслеживания обновлений всех свойств или свойства с указанным именем.
PropertyChangeListener[] getPropertyChangeListeners()
Возвращает массив всех слушателей, добавленных к объекту PropertyChangeSupport с помощью addPropertyChangeListener().
PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
Возвращает массив всех слушателей, связанных с указанным свойством.
boolean hasListeners(String propertyName)
Проверяет наличие слушателей для конкретного свойства, включая тех, кто зарегистрирован для всех свойств.
void removePropertyChangeListener(PropertyChangeListener listener)
Удаляет PropertyChangeListener из списка слушателей.
void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
Удаляет PropertyChangeListener для определённого свойства.

Методы, унаследованные от класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание конструкторов

PropertyChangeSupport

public PropertyChangeSupport(Object sourceBean)
Создаёт объект PropertyChangeSupport.
Параметры:
sourceBean - Компонент, который будет источником событий.

Подробное описание методов

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)
Добавляет обработчик PropertyChangeListener в список слушателей. Обработчик регистрируется для всех свойств. Один и тот же объект слушателя может быть добавлен более одного раза, и он будет вызван столько раз, сколько он был добавлен. Если listener равно null, исключение не выбрасывается, и никаких действий не выполняется.
Параметры:
listener - Добавляемый обработчик PropertyChangeListener

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)
Удаляет обработчик PropertyChangeListener из списка слушателей. Это удаляет обработчик PropertyChangeListener, который был зарегистрирован для всех свойств. Если listener был добавлен более одного раза к одному и тому же источнику событий, он будет уведомлён на одну операцию меньше после удаления. Если listener равно null или никогда не добавлялся, исключение не выбрасывается, и никаких действий не выполняется.
Параметры:
listener - Удаляемый обработчик PropertyChangeListener

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners()
Возвращает массив всех слушателей, которые были добавлены к объекту PropertyChangeSupport с помощью addPropertyChangeListener().

Если некоторые слушатели были добавлены со свойством с именем, возвращаемый массив будет смесью PropertyChangeListeners и PropertyChangeListenerProxy. Если вызывающий метод заинтересован в различении слушателей, он должен проверить каждый элемент, чтобы увидеть, является ли он PropertyChangeListenerProxy, выполнить приведение типов и изучить параметр.


 PropertyChangeListener[] listeners = bean.getPropertyChangeListeners();
 for (int i = 0; i < listeners.length; i++) {
   if (listeners[i] instanceof PropertyChangeListenerProxy) {
     PropertyChangeListenerProxy proxy =
                    (PropertyChangeListenerProxy)listeners[i];
     if (proxy.getPropertyName().equals("foo")) {
       // proxy is a PropertyChangeListener which was associated
       // with the property named "foo"
     }
   }
 }
 
Возвращает:
все добавленные PropertyChangeListeners или пустой массив, если слушатели не были добавлены
С:
1.4
См. также:
  • PropertyChangeListenerProxy

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
Добавляет обработчик PropertyChangeListener для определённого свойства. Обработчик будет вызываться только тогда, когда вызов firePropertyChange указывает на это конкретное свойство. Один и тот же объект слушателя может быть добавлен более одного раза. Для каждого свойства слушатель будет вызываться количество раз, равное количеству его добавлений для этого свойства. Если propertyName или listener равно null, исключение не выбрасывается, и никаких действий не выполняется.
Параметры:
propertyName - Имя свойства, за которым нужно следить.
listener - Добавляемый обработчик PropertyChangeListener
С:
1.2

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
Удаляет обработчик PropertyChangeListener для определённого свойства. Если listener был добавлен более одного раза к одному и тому же источнику событий для указанного свойства, он будет уведомлён на одну операцию меньше после удаления. Если propertyName равно null, исключение не выбрасывается, и никаких действий не выполняется. Если listener равно null или никогда не добавлялся для указанного свойства, исключение не выбрасывается, и никаких действий не выполняется.
Параметры:
propertyName - Имя свойства, за которым следили.
listener - Удаляемый обработчик PropertyChangeListener
С:
1.2

getPropertyChangeListeners

public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
Возвращает массив всех слушателей, связанных с именем свойства.
Параметры:
propertyName - Имя свойства, за которым ведётся наблюдение
Возвращает:
все PropertyChangeListeners , связанные с заданным свойством. Если такие слушатели не были добавлены или propertyName равно null, возвращается пустой массив.
С:
1.4

firePropertyChange

public void firePropertyChange(String propertyName, Object oldValue, Object newValue)
Сообщает слушателям о связанном изменении свойства, которые были зарегистрированы для отслеживания обновлений всех свойств или свойства с указанным именем.

Событие не генерируется, если старое и новое значения равны и не равны null.

Это просто удобная обёртка вокруг более общего метода firePropertyChange(PropertyChangeEvent).

Параметры:
propertyName - Программное имя изменённого свойства
oldValue - Старое значение свойства
newValue - Новое значение свойства

firePropertyChange

public void firePropertyChange(String propertyName, int oldValue, int newValue)
Сообщает слушателям об обновлении целочисленного связанного свойства, которые были зарегистрированы для отслеживания обновлений всех свойств или свойства с указанным именем.

Событие не генерируется, если старое и новое значения равны.

Это просто удобная обёртка вокруг более общего метода firePropertyChange(String, Object, Object).

Параметры:
propertyName - Программное имя изменённого свойства
oldValue - Старое значение свойства
newValue - Новое значение свойства
С:
1.2

firePropertyChange

public void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)
Сообщает слушателям об обновлении булевого связанного свойства, которые были зарегистрированы для отслеживания обновлений всех свойств или свойства с указанным именем.

Событие не генерируется, если старое и новое значения равны.

Это просто удобная обёртка вокруг более общего метода firePropertyChange(String, Object, Object).

Параметры:
propertyName - Программное имя изменённого свойства
oldValue - Старое значение свойства
newValue - Новое значение свойства
С:
1.2

firePropertyChange

public void firePropertyChange(PropertyChangeEvent event)
Генерирует событие изменения свойства для слушателей, зарегистрированных для отслеживания обновлений всех свойств или свойства с указанным именем.

Событие не генерируется, если старое и новое значения события равны и не равны null.

Параметры:
event - Событие PropertyChangeEvent для генерации
С:
1.2

fireIndexedPropertyChange

public void fireIndexedPropertyChange(String propertyName, int index, Object oldValue, Object newValue)
Сообщает слушателям об обновлении связанного индексированного свойства, которые были зарегистрированы для отслеживания обновлений всех свойств или свойства с указанным именем.

Событие не генерируется, если старое и новое значения равны и не равны null.

Это просто удобная обёртка вокруг более общего метода firePropertyChange(PropertyChangeEvent).

Параметры:
propertyName - Программное имя изменённого свойства
index - Индекс элемента свойства, который был изменён
oldValue - Старое значение свойства
newValue - Новое значение свойства
С:
1.5

fireIndexedPropertyChange

public void fireIndexedPropertyChange(String propertyName, int index, int oldValue, int newValue)
Сообщает слушателям об обновлении связанного индексированного целочисленного свойства, которые были зарегистрированы для отслеживания обновлений всех свойств или свойства с указанным именем.

Событие не генерируется, если старое и новое значения равны.

Это просто удобная обёртка вокруг более общего метода fireIndexedPropertyChange(String, int, Object, Object).

Параметры:
propertyName - Программное имя изменённого свойства
index - Индекс элемента свойства, который был изменён
oldValue - Старое значение свойства
newValue - Новое значение свойства
С:
1.5

fireIndexedPropertyChange

public void fireIndexedPropertyChange(String propertyName, int index, boolean oldValue, boolean newValue)
Сообщает слушателям об обновлении связанного индексированного булевого свойства, которые были зарегистрированы для отслеживания обновлений всех свойств или свойства с указанным именем.

Событие не генерируется, если старое и новое значения равны.

Это просто удобная обёртка вокруг более общего метода fireIndexedPropertyChange(String, int, Object, Object).

Параметры:
propertyName - Программное имя изменённого свойства
index - Индекс элемента свойства, который был изменён
oldValue - Старое значение свойства
newValue - Новое значение свойства
С:
1.5

hasListeners

public boolean hasListeners(String propertyName)
Проверяет, существуют ли слушатели для определённого свойства, включая зарегистрированные для всех свойств. Если propertyName равно null, проверяются только слушатели, зарегистрированные для всех свойств.
Параметры:
propertyName - Имя свойства.
Возвращает:
true, если для данного свойства есть один или несколько слушателей
С:
1.2

© 1993, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/beans/PropertyChangeSupport.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API