griffon.core.artifact

Interface GriffonArtifact

All Superinterfaces:

MVCHandler, ResourceHandler, ThreadingHandler

All Known Subinterfaces:

GriffonController, GriffonModel, GriffonMvcArtifact, GriffonService, GriffonView, JavaFXGriffonView

All Known Implementing Classes:

AbstractGriffonArtifact, AbstractGriffonController, AbstractGriffonModel, AbstractGriffonMvcArtifact, AbstractGriffonService, AbstractGriffonView, AbstractJavaFXGriffonView, AbstractLanternaGriffonView, AbstractPivotGriffonView, AbstractSwingGriffonView

public interface GriffonArtifact
extends ThreadingHandler, MVCHandler, ResourceHandler

Identifies an object as a Griffon artifact.

Griffon artifacts are usually placed under the special "griffon-app" directory that every application has. They are also grouped together in in a subdirectory that clearly identifies their nature. For example "griffon-app/controllers" contains all Controller artifacts.

Implementing this interface for a custom artifact definition is highly recommended but not enforced.

Since:

2.0.0

Author:

Andres Almiray

Method Summary

Modifier and Type	Method and Description
GriffonApplication	getApplication() Reference to the current GriffonApplication
GriffonClass	getGriffonClass() Returns the GriffonClass associated with this artifact.
org.slf4j.Logger	getLog() Returns a Logger instance suitable for this Artifact.
Class<? extends GriffonArtifact>	getTypeClass() Returns the Class of this artifact.

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

Method Detail

getApplication

GriffonApplication getApplication()

Reference to the current GriffonApplication

Returns:

the currently running application

getGriffonClass

@Nonnull
GriffonClass getGriffonClass()

Returns the GriffonClass associated with this artifact.

Returns:

the GriffonClass associated with this artifact

getTypeClass

@Nonnull
Class<? extends GriffonArtifact> getTypeClass()

Returns the Class of this artifact.

Returns:

the Class of this artifact.

Since:

2.10.0

getLog

@Nonnull
org.slf4j.Logger getLog()

Returns a Logger instance suitable for this Artifact.

The Logger is configured with the following prefix 'griffon.app.<type>' where <type> stands for the artifact's type.

Example: the Logger for class com.acme.SampleController will be configured for 'griffon.app.controller.com.acme.SampleController'.

Returns:

a Logger instance associated with this artifact.