org.codehaus.griffon.runtime.core.artifact

Class AbstractGriffonModel

java.lang.Object

org.codehaus.griffon.runtime.core.artifact.AbstractGriffonArtifact

org.codehaus.griffon.runtime.core.artifact.AbstractGriffonMvcArtifact

org.codehaus.griffon.runtime.core.artifact.AbstractGriffonModel

All Implemented Interfaces:

GriffonArtifact, GriffonModel, GriffonMvcArtifact, MVCHandler, Observable, ResourceHandler, ThreadingHandler, Vetoable

public abstract class AbstractGriffonModel
extends AbstractGriffonMvcArtifact
implements GriffonModel

Base implementation of the GriffonModel interface.

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
protected PropertyChangeSupport	pcs
protected VetoableChangeSupport	vcs

Fields inherited from class org.codehaus.griffon.runtime.core.artifact.AbstractGriffonArtifact

application

Constructor Summary

Constructors

Constructor and Description
AbstractGriffonModel()
AbstractGriffonModel(GriffonApplication application) Deprecated. Griffon prefers field injection over constructor injector for artifacts as of 2.1.0

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Adds the given PropertyChangeListener to the listener list.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Removes the given PropertyChangeListener from the listener list.
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	firePropertyChange(PropertyChangeEvent event)
protected void	firePropertyChange(String propertyName, Object oldValue, Object newValue)
protected void	fireVetoableChange(PropertyChangeEvent event)
protected void	fireVetoableChange(String propertyName, Object oldValue, Object newValue)
protected String	getArtifactType()
PropertyChangeListener[]	getPropertyChangeListeners() Returns an array of all the listeners that were added with addPropertyChangeListener().
PropertyChangeListener[]	getPropertyChangeListeners(String propertyName) Returns an array of all the listeners which have been associated with the named property.
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	removePropertyChangeListener(PropertyChangeListener listener) Removes the given PropertyChangeListener from the listener list.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener) Removes the given PropertyChangeListener from the listener list.
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.artifact.AbstractGriffonMvcArtifact

createMVC, createMVC, createMVC, createMVC, createMVC, createMVC, createMVC, createMVC, createMVC, createMVC, createMVC, createMVC, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, destroyMVCGroup, getMvcGroup, mvcGroupDestroy, mvcGroupInit, setMvcGroup, withMVC, withMVC, withMVC, withMVC, withMVC, withMVC, withMVC, withMVC, withMVC, withMVC, withMVC, withMVC, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup

Methods inherited from class org.codehaus.griffon.runtime.core.artifact.AbstractGriffonArtifact

classloader, getApplication, getGriffonClass, getLog, getResourceAsStream, getResourceAsURL, getResources, getTypeClass, isUIThread, msg, msg, msg, msg, runFuture, runFuture, runInsideUIAsync, runInsideUISync, runInsideUISync, runOutsideUI, runOutsideUIAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface griffon.core.artifact.GriffonMvcArtifact

getMvcGroup, mvcGroupDestroy, mvcGroupInit

Methods inherited from interface griffon.core.artifact.GriffonArtifact

getApplication, getGriffonClass, getLog, getTypeClass

Methods inherited from interface griffon.core.threading.ThreadingHandler

isUIThread, runFuture, runFuture, runInsideUIAsync, runInsideUISync, runInsideUISync, runOutsideUI, runOutsideUIAsync

Methods inherited from interface griffon.core.mvc.MVCHandler

createMVC, createMVC, createMVC, createMVC, createMVC, createMVC, createMVC, createMVC, createMVC, createMVC, createMVC, createMVC, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, destroyMVCGroup, withMVC, withMVC, withMVC, withMVC, withMVC, withMVC, withMVC, withMVC, withMVC, withMVC, withMVC, withMVC, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup

Methods inherited from interface griffon.core.resources.ResourceHandler

classloader, getResourceAsStream, getResourceAsURL, getResources

Field Detail

pcs

protected final PropertyChangeSupport pcs

vcs

protected final VetoableChangeSupport vcs

Constructor Detail

AbstractGriffonModel

public AbstractGriffonModel()

AbstractGriffonModel

@Inject
 @Deprecated
public AbstractGriffonModel(@Nonnull
                                                 GriffonApplication application)

Deprecated. Griffon prefers field injection over constructor injector for artifacts as of 2.1.0

Creates a new instance of this class.

Parameters:

application - the GriffonApplication that holds this artifact.

Method Detail

getArtifactType

@Nonnull
protected String getArtifactType()

Specified by:

getArtifactType in class AbstractGriffonArtifact

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

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
                                         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

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()

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.

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.

addPropertyChangeListener

public void addPropertyChangeListener(@Nullable
                                      PropertyChangeListener listener)

Description copied from interface: Observable

Adds the given PropertyChangeListener to the listener list.

The listener is registered for all bound properties of this class.

Specified by:

addPropertyChangeListener in interface Observable

Parameters:

listener - the PropertyChangeListener to be added

See Also:

Observable.removePropertyChangeListener(PropertyChangeListener)

addPropertyChangeListener

public void addPropertyChangeListener(@Nullable
                                      String propertyName,
                                      @Nullable
                                      PropertyChangeListener listener)

Description copied from interface: Observable

Removes the given PropertyChangeListener from the listener list.

The listener is registered an specific property of this class.

Specified by:

addPropertyChangeListener in interface Observable

Parameters:

propertyName - The name of the property to listen on.

listener - the PropertyChangeListener to be added

See Also:

Observable.removePropertyChangeListener(String, PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(@Nullable
                                         PropertyChangeListener listener)

Description copied from interface: Observable

Removes the given PropertyChangeListener from the listener list.

This method should be used to remove PropertyChangeListeners that were registered for all bound properties of this class.

Specified by:

removePropertyChangeListener in interface Observable

Parameters:

listener - the PropertyChangeListener to be removed

See Also:

Observable.addPropertyChangeListener(PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(@Nullable
                                         String propertyName,
                                         @Nullable
                                         PropertyChangeListener listener)

Description copied from interface: Observable

Removes the given PropertyChangeListener from the listener list.

This method should be used to remove PropertyChangeListeners that were registered for an specific property of this class.

Specified by:

removePropertyChangeListener in interface Observable

Parameters:

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

listener - the PropertyChangeListener to be removed

See Also:

Observable.addPropertyChangeListener(String, PropertyChangeListener)

getPropertyChangeListeners

@Nonnull
public PropertyChangeListener[] getPropertyChangeListeners()

Description copied from interface: Observable

Returns an array of all the listeners that were added with addPropertyChangeListener().

Specified by:

getPropertyChangeListeners in interface Observable

Returns:

all of the PropertyChangeListeners added or an empty array if no listeners have been added.

getPropertyChangeListeners

@Nonnull
public PropertyChangeListener[] getPropertyChangeListeners(@Nullable
                                                                    String propertyName)

Description copied from interface: Observable

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

Specified by:

getPropertyChangeListeners in interface Observable

Parameters:

propertyName - The name of the property being listened to

Returns:

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

firePropertyChange

protected void firePropertyChange(@Nonnull
                                  PropertyChangeEvent event)

firePropertyChange

protected void firePropertyChange(@Nonnull
                                  String propertyName,
                                  @Nullable
                                  Object oldValue,
                                  @Nullable
                                  Object newValue)

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