org.codehaus.griffon.runtime.core.artifact

Class AbstractArtifactHandler<A extends GriffonArtifact>

java.lang.Object

org.codehaus.griffon.runtime.core.artifact.AbstractArtifactHandler<A>

All Implemented Interfaces:

ArtifactHandler<A>

Direct Known Subclasses:

ControllerArtifactHandler, ModelArtifactHandler, ServiceArtifactHandler, ViewArtifactHandler

public abstract class AbstractArtifactHandler<A extends GriffonArtifact>
extends java.lang.Object
implements ArtifactHandler<A>

Base implementation of the ArtifactHandler interface.

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ERROR_CLASS_NULL

Constructor Summary

Constructors

Constructor and Description
AbstractArtifactHandler(GriffonApplication application, java.lang.Class<A> artifactType, java.lang.String type, java.lang.String trailing)

Method Summary

Modifier and Type	Method and Description
GriffonClass	findClassFor(java.lang.String propertyName) Finds an artifact by its property name.
protected GriffonApplication	getApplication()
java.lang.Class<A>	getArtifactType()
GriffonClass[]	getClasses() Returns the set of all artifact classes this handler manages.
java.util.Map<java.lang.String,GriffonClass>	getClassesByName()
GriffonClass	getClassFor(java.lang.Class<A> clazz) Finds an artifact if the target clazz is handled by this ArtifactHandler.
GriffonClass	getClassFor(java.lang.String fqnClassName) Finds an artifact by class name if it represents a class that is handled by this ArtifactHandler.
java.lang.String	getTrailing() Get the trailing suffix that identifies the artifact.
java.lang.String	getType() Get the type of artifact this handler processes.
void	initialize(java.lang.Class<A>[] classes) Initializes the handler with a collection of all available classes this handler can process.
boolean	isArtifact(java.lang.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.

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

newGriffonClassInstance

Field Detail

ERROR_CLASS_NULL

protected static final java.lang.String ERROR_CLASS_NULL

See Also:

Constant Field Values

Constructor Detail

AbstractArtifactHandler

@Inject
public AbstractArtifactHandler(@Nonnull
                                       GriffonApplication application,
                                       @Nonnull
                                       java.lang.Class<A> artifactType,
                                       @Nonnull
                                       java.lang.String type,
                                       @Nonnull
                                       java.lang.String trailing)

Method Detail

getArtifactType

@Nonnull
public java.lang.Class<A> getArtifactType()

Specified by:

getArtifactType in interface ArtifactHandler<A extends GriffonArtifact>

getType

@Nonnull
public java.lang.String getType()

Description copied from interface: ArtifactHandler

Get the type of artifact this handler processes.

Specified by:

getType in interface ArtifactHandler<A extends GriffonArtifact>

Returns:

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

getTrailing

@Nonnull
public java.lang.String getTrailing()

Description copied from interface: ArtifactHandler

Get the trailing suffix that identifies the artifact.

May be empty but non-null.

Specified by:

getTrailing in interface ArtifactHandler<A extends GriffonArtifact>

Returns:

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

initialize

public void initialize(@Nonnull
                       java.lang.Class<A>[] classes)

Description copied from interface: ArtifactHandler

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.

Specified by:

initialize in interface ArtifactHandler<A extends GriffonArtifact>

Parameters:

classes - an array of all classes this handler should manage

getClassesByName

@Nonnull
public java.util.Map<java.lang.String,GriffonClass> getClassesByName()

Specified by:

getClassesByName in interface ArtifactHandler<A extends GriffonArtifact>

isArtifact

public boolean isArtifact(@Nonnull
                          java.lang.Class<A> clazz)

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

This implementation performs an equality check on class.name

Specified by:

isArtifact in interface ArtifactHandler<A extends GriffonArtifact>

Parameters:

clazz - a Class instance

Returns:

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

isArtifact

public boolean isArtifact(@Nonnull
                          GriffonClass clazz)

Description copied from interface: ArtifactHandler

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

Specified by:

isArtifact in interface ArtifactHandler<A extends GriffonArtifact>

Parameters:

clazz - a GriffonClass instance

Returns:

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

getClasses

@Nonnull
public GriffonClass[] getClasses()

Description copied from interface: ArtifactHandler

Returns the set of all artifact classes this handler manages.

Specified by:

getClasses in interface ArtifactHandler<A extends GriffonArtifact>

Returns:

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

getClassFor

@Nullable
public GriffonClass getClassFor(@Nonnull
                                          java.lang.Class<A> clazz)

Description copied from interface: ArtifactHandler

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

Specified by:

getClassFor in interface ArtifactHandler<A extends GriffonArtifact>

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
public GriffonClass getClassFor(@Nonnull
                                          java.lang.String fqnClassName)

Description copied from interface: ArtifactHandler

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

Specified by:

getClassFor in interface ArtifactHandler<A extends GriffonArtifact>

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.

findClassFor

@Nullable
public GriffonClass findClassFor(@Nonnull
                                           java.lang.String propertyName)

Description copied from interface: ArtifactHandler

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.

Specified by:

findClassFor in interface ArtifactHandler<A extends GriffonArtifact>

Parameters:

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

Returns:

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

getApplication

@Nonnull
protected GriffonApplication getApplication()