griffon.core.artifact

Interface GriffonControllerClass

All Superinterfaces:

GriffonClass

All Known Implementing Classes:

DefaultGriffonControllerClass

public interface GriffonControllerClass
extends GriffonClass

Represents a Controller class in Griffon.

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TRAILING "Controller"
static java.lang.String	TYPE "controller"

Fields inherited from interface griffon.core.artifact.GriffonClass

STANDARD_PROPERTIES

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getActionNames() Matches all public methods and all properties that have a Closure as value.
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.

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

"controller"

See Also:

Constant Field Values

TRAILING

static final java.lang.String TRAILING

"Controller"

See Also:

Constant Field Values

Method Detail

getActionNames

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

Matches all public methods and all properties that have a Closure as value.

Actions are subject to the following rules in order to be considered as such:

• must have public (Java) or default (Groovy) visibility modifier.
• name does not match an event handler, i.e, it does not begin with on.
• must pass {code GriffonClassUtils.isPlainMethod()} if it's a method.
• must have void as return type if it's a method.
• value must be a closure (including curried method pointers) if it's a property.

Returns:

an array containing the names of all action names.

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.