griffon.core.artifact

Interface GriffonModelClass

All Superinterfaces:

GriffonClass

All Known Implementing Classes:

DefaultGriffonModelClass

public interface GriffonModelClass
extends GriffonClass

Represents a Model class in Griffon.

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TRAILING "Model"
static java.lang.String	TYPE "model"

Fields inherited from interface griffon.core.artifact.GriffonClass

STANDARD_PROPERTIES

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getEventNames() Matches all public methods and closure properties whose name matches the event handler convention, i.e, starts with "on" and is followed by at least one uppercase character.
java.lang.Object	getModelPropertyValue(GriffonModel model, java.lang.String propertyName) Returns the value of a model property.
java.lang.String[]	getPropertyNames() Matches all public properties that are not event handlers nor have a Closure as their value.
void	setModelPropertyValue(GriffonModel model, java.lang.String propertyName, java.lang.Object value) Sets a value of a model property.

Methods inherited from interface griffon.core.artifact.GriffonClass

getApplication, getArtifactType, getClazz, getFullName, getLogicalPropertyName, getName, getNaturalName, getPackageName, getPropertyName, getPropertyValue, getPropertyValue, getShortName, hasProperty

Field Detail

TYPE

static final java.lang.String TYPE

"model"

See Also:

Constant Field Values

TRAILING

static final java.lang.String TRAILING

"Model"

See Also:

Constant Field Values

Method Detail

getPropertyNames

@Nonnull
java.lang.String[] getPropertyNames()

Matches all public properties that are not event handlers nor have a Closure as their value.

Returns:

an array containing the names of all model properties.

getEventNames

@Nonnull
java.lang.String[] getEventNames()

Matches all public methods and closure properties whose name matches the event handler convention, i.e, starts with "on" and is followed by at least one uppercase character.

Returns:

an array containing the names of all event handlers.

setModelPropertyValue

void setModelPropertyValue(@Nonnull
                           GriffonModel model,
                           @Nonnull
                           java.lang.String propertyName,
                           @Nullable
                           java.lang.Object value)

Sets a value of a model property.

Parameters:

model - the model to be affected

propertyName - the name of the property to update

value - new value

getModelPropertyValue

@Nullable
java.lang.Object getModelPropertyValue(@Nonnull
                                                 GriffonModel model,
                                                 @Nonnull
                                                 java.lang.String propertyName)

Returns the value of a model property.

Parameters:

model - the model to query

propertyName - the name of the property to query

Returns:

the value of the property