Spec-Zone.ru › OpenJDK 17

Класс 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)
Сообщает слушателям об обновлении индексированного связанного свойства типа boolean, если они были зарегистрированы для отслеживания обновлений всех свойств или свойства с указанным именем.
void fireIndexedPropertyChange(String propertyName, int index, int oldValue, int newValue)
Сообщает слушателям об обновлении индексированного связанного свойства типа int, если они были зарегистрированы для отслеживания обновлений всех свойств или свойства с указанным именем.
void fireIndexedPropertyChange(String propertyName, int index, Object oldValue, Object newValue)
Сообщает слушателям об обновлении индексированного связанного свойства, если они были зарегистрированы для отслеживания обновлений всех свойств или свойства с указанным именем.
void firePropertyChange(PropertyChangeEvent event)
Отправляет событие изменения свойства слушателям, которые были зарегистрированы для отслеживания обновлений всех свойств или свойства с указанным именем.
void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)
Сообщает слушателям об обновлении связанного свойства типа boolean, если они были зарегистрированы для отслеживания обновлений всех свойств или свойства с указанным именем.
void firePropertyChange(String propertyName, int oldValue, int newValue)
Сообщает слушателям об обновлении связанного свойства типа int, если они были зарегистрированы для отслеживания обновлений всех свойств или свойства с указанным именем.
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().

Если некоторые слушатели были добавлены с указанным именем свойства, то возвращаемый массив будет содержать смесь обработчиков PropertyChangeListener и 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, 2021, 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/17/docs/api/java.desktop/java/beans/PropertyChangeSupport.html

Spec-Zone.ru

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