org.codehaus.griffon.runtime.core

Class AbstractVetoable

java.lang.Object

org.codehaus.griffon.runtime.core.AbstractObservable

org.codehaus.griffon.runtime.core.AbstractVetoable

All Implemented Interfaces:

Observable, Vetoable

public class AbstractVetoable
extends AbstractObservable
implements Vetoable

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
protected VetoableChangeSupport	vcs

Fields inherited from class org.codehaus.griffon.runtime.core.AbstractObservable

pcs

Constructor Summary

Constructors

Constructor and Description
AbstractVetoable()

Method Summary

Methods

Modifier and Type	Method and Description
void	addVetoableChangeListener(String propertyName, VetoableChangeListener listener) Add a VetoableChangeListener for a specific property.
void	addVetoableChangeListener(VetoableChangeListener listener) Add a VetoableListener to the listener list.
protected void	fireVetoableChange(PropertyChangeEvent event)
protected void	fireVetoableChange(String propertyName, Object oldValue, Object newValue)
VetoableChangeListener[]	getVetoableChangeListeners() Returns the list of VetoableChangeListeners.
VetoableChangeListener[]	getVetoableChangeListeners(String propertyName) Returns an array of all the listeners which have been associated with the named property.
void	removeVetoableChangeListener(String propertyName, VetoableChangeListener listener) Remove a VetoableChangeListener for a specific property.
void	removeVetoableChangeListener(VetoableChangeListener listener) Remove a VetoableChangeListener from the listener list.

Methods inherited from class org.codehaus.griffon.runtime.core.AbstractObservable

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface griffon.core.Observable

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Field Detail

vcs

protected final VetoableChangeSupport vcs

Constructor Detail

AbstractVetoable

public AbstractVetoable()

Method Detail

addVetoableChangeListener

public void addVetoableChangeListener(@Nullable
                             VetoableChangeListener listener)

Description copied from interface: Vetoable

Add a VetoableListener to the listener list. The listener is registered for all properties. The same listener object may be added more than once, and will be called as many times as it is added. If listener is null, no exception is thrown and no action is taken.

Specified by:

addVetoableChangeListener in interface Vetoable

Parameters:

listener - The VetoableChangeListener to be added

removeVetoableChangeListener

public void removeVetoableChangeListener(@Nullable
                                VetoableChangeListener listener)

Description copied from interface: Vetoable

Remove a VetoableChangeListener from the listener list. This removes a VetoableChangeListener that was registered for all properties. If listener was added more than once to the same event source, it will be notified one less time after being removed. If listener is null, or was never added, no exception is thrown and no action is taken.

Specified by:

removeVetoableChangeListener in interface Vetoable

Parameters:

listener - The VetoableChangeListener to be removed

getVetoableChangeListeners

@Nonnull
public VetoableChangeListener[] getVetoableChangeListeners()

Description copied from interface: Vetoable

Returns the list of VetoableChangeListeners. If named vetoable change listeners were added, then VetoableChangeListenerProxy wrappers will returned

Specified by:

getVetoableChangeListeners in interface Vetoable

Returns:

List of VetoableChangeListeners and VetoableChangeListenerProxys if named property change listeners were added.

addVetoableChangeListener

public void addVetoableChangeListener(@Nullable
                             String propertyName,
                             @Nullable
                             VetoableChangeListener listener)

Description copied from interface: Vetoable

Add a VetoableChangeListener for a specific property. The listener will be invoked only when a call on fireVetoableChange names that specific property. The same listener object may be added more than once. For each property, the listener will be invoked the number of times it was added for that property. If propertyName or listener is null, no exception is thrown and no action is taken.

Specified by:

addVetoableChangeListener in interface Vetoable

Parameters:

propertyName - The name of the property to listen on.

listener - The VetoableChangeListener to be added

removeVetoableChangeListener

public void removeVetoableChangeListener(@Nullable
                                String propertyName,
                                @Nullable
                                VetoableChangeListener listener)

Description copied from interface: Vetoable

Remove a VetoableChangeListener for a specific property. If listener was added more than once to the same event source for the specified property, it will be notified one less time after being removed. If propertyName is null, no exception is thrown and no action is taken. If listener is null, or was never added for the specified property, no exception is thrown and no action is taken.

Specified by:

removeVetoableChangeListener in interface Vetoable

Parameters:

propertyName - The name of the property that was listened on.

listener - The VetoableChangeListener to be removed

getVetoableChangeListeners

@Nonnull
public VetoableChangeListener[] getVetoableChangeListeners(@Nullable
                                                          String propertyName)

Description copied from interface: Vetoable

Returns an array of all the listeners which have been associated with the named property.

Specified by:

getVetoableChangeListeners in interface Vetoable

Parameters:

propertyName - The name of the property being listened to

Returns:

all the VetoableChangeListeners associated with the named property. If no such listeners have been added, or if propertyName is null, an empty array is returned.

fireVetoableChange

protected void fireVetoableChange(@Nonnull
                      PropertyChangeEvent event)
                           throws PropertyVetoException

Throws:

PropertyVetoException

fireVetoableChange

protected void fireVetoableChange(@Nonnull
                      String propertyName,
                      @Nullable
                      Object oldValue,
                      @Nullable
                      Object newValue)
                           throws PropertyVetoException

Throws:

PropertyVetoException