griffon.core.artifact

Interface ArtifactHandler<A extends GriffonArtifact>

All Known Implementing Classes:

AbstractArtifactHandler, ControllerArtifactHandler, ModelArtifactHandler, ServiceArtifactHandler, ViewArtifactHandler

public interface ArtifactHandler<A extends GriffonArtifact>

The ArtifactHandler interface's purpose is to allow the analysis of conventions within a Griffon application.

An artifact is represented by the GriffonClass interface and this interface provides methods that allow artifacts to be identified, created and initialized.

Author:

Andres Almiray

Method Summary

Modifier and Type	Method and Description
GriffonClass	findClassFor(String propertyName) Finds an artifact by its property name.
Class<A>	getArtifactType()
GriffonClass[]	getClasses() Returns the set of all artifact classes this handler manages.
Map<String,GriffonClass>	getClassesByName()
GriffonClass	getClassFor(Class<A> clazz) Finds an artifact if the target clazz is handled by this ArtifactHandler.
GriffonClass	getClassFor(String fqnClassName) Finds an artifact by class name if it represents a class that is handled by this ArtifactHandler.
String	getTrailing() Get the trailing suffix that identifies the artifact.
String	getType() Get the type of artifact this handler processes.
Collection<Binding<?>>	initialize(Class<A>[] classes) Initializes the handler with a collection of all available classes this handler can process.
boolean	isArtifact(Class<A> clazz) Returns true if the target Class is a class artifact handled by this object.
boolean	isArtifact(GriffonClass clazz) Returns true if the target GriffonClass is a class artifact handled by this object.
GriffonClass	newGriffonClassInstance(Class<A> clazz)

Method Detail

getArtifactType

@Nonnull
Class<A> getArtifactType()

getType

@Nonnull
String getType()

Get the type of artifact this handler processes.

Returns:

the type of artifacts this handler can handle, e.g. 'service'

getTrailing

@Nonnull
String getTrailing()

Get the trailing suffix that identifies the artifact.

May be empty but non-null.

Returns:

the trailing name suffix (if any), e.g. 'Service'

isArtifact

boolean isArtifact(@Nonnull
                   Class<A> clazz)

Returns true if the target Class is a class artifact handled by this object.

Parameters:

clazz - a Class instance

Returns:

true if this handler is capable of handling the artifact class, false otherwise.

isArtifact

boolean isArtifact(@Nonnull
                   GriffonClass clazz)

Returns true if the target GriffonClass is a class artifact handled by this object.

Parameters:

clazz - a GriffonClass instance

Returns:

true if this handler is capable of handling the clazz parameter, false otherwise.

initialize

@Nonnull
Collection<Binding<?>> initialize(@Nonnull
                                           Class<A>[] classes)

Initializes the handler with a collection of all available classes this handler can process.

This is a good time to pre-emptively instantiate beans or perform additional checks on artifacts.

Parameters:

classes - an array of all classes this handler should manage

getClasses

@Nonnull
GriffonClass[] getClasses()

Returns the set of all artifact classes this handler manages.

Returns:

an array of all GriffonClasses managed by this handler. Never returns null.

findClassFor

@Nullable
GriffonClass findClassFor(@Nonnull
                                    String propertyName)

Finds an artifact by its property name.

Examples: findClassfor("fooService") returns an artifact class that can handle FooService.

Should propertyName contain any dots then the portion after the last dot will be considered only.

Parameters:

propertyName - the property representation of an artifact, e.g. 'fooService'

Returns:

a GriffonClass instance if there's a match, null otherwise.

getClassFor

@Nullable
GriffonClass getClassFor(@Nonnull
                                   Class<A> clazz)

Finds an artifact if the target clazz is handled by this ArtifactHandler.

Parameters:

clazz - a class object, i.e, BookController

Returns:

a GriffonClass that can handle the target class or null if the clazz is not handled by this ArtifactHandler.

getClassFor

@Nullable
GriffonClass getClassFor(@Nonnull
                                   String fqnClassName)

Finds an artifact by class name if it represents a class that is handled by this ArtifactHandler.

Parameters:

fqnClassName - a full qualified class name, i.e, "book.BookController"

Returns:

a GriffonClass that can handle the target class or null if the clazz is not handled by this ArtifactHandler.

newGriffonClassInstance

@Nonnull
GriffonClass newGriffonClassInstance(@Nonnull
                                              Class<A> clazz)

getClassesByName

@Nonnull
Map<String,GriffonClass> getClassesByName()