org.codehaus.griffon.runtime.core.artifact

Class AbstractArtifactManager

java.lang.Object

org.codehaus.griffon.runtime.core.artifact.AbstractArtifactManager

All Implemented Interfaces:

ArtifactManager, ShutdownHandler

Direct Known Subclasses:

DefaultArtifactManager

public abstract class AbstractArtifactManager
extends Object
implements ArtifactManager

Base implementation of the ArtifactManager interface.

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ERROR_ARTIFACT_HANDLER_NULL

Fields inherited from interface griffon.core.artifact.ArtifactManager

EMPTY_GRIFFON_CLASS_LIST

Constructor Summary

Constructors

Constructor and Description
AbstractArtifactManager()

Method Summary

Modifier and Type	Method and Description
boolean	canShutdown(GriffonApplication application) Asks this handler if the application's shutdown sequence can proceed or not.
protected abstract Map<String,List<Class<? extends GriffonArtifact>>>	doLoadArtifactMetadata()
<A extends GriffonArtifact> GriffonClass	findGriffonClass(A artifact) Finds an artifact by class.
GriffonClass	findGriffonClass(Class<? extends GriffonArtifact> clazz) Finds an artifact by class.
GriffonClass	findGriffonClass(Class<? extends GriffonArtifact> clazz, String type) Finds an artifact by class and type.
GriffonClass	findGriffonClass(String fqClassName) Finds an artifact by name.
GriffonClass	findGriffonClass(String name, String type) Finds an artifact by name and type.
List<GriffonClass>	getAllClasses() Finds all artifact classes.
Set<String>	getAllTypes() Finds all supported artifact types.
protected Map<String,ArtifactHandler>	getArtifactHandlers()
List<GriffonClass>	getClassesOfType(String type) Finds all artifacts of an specific type.
protected boolean	isArtifactTypeSupported(String type)
protected <A extends GriffonArtifact> boolean	isClassOfType(String type, Class<A> clazz)
void	loadArtifactMetadata(Injector<?> injector) Reads the artifacts definitions file from the classpath.
<A extends GriffonArtifact> A	newInstance(Class<A> clazz) Creates a new instance of the specified class and type. Triggers the ApplicationEvent.NEW_INSTANCE with the following parameters clazz - the Class of the object instance -> the object that was created
<A extends GriffonArtifact> A	newInstance(GriffonClass griffonClass) Creates a new instance of the specified class and type. Triggers the ApplicationEvent.NEW_INSTANCE with the following parameters clazz - the Class of the object instance -> the object that was created
void	onShutdown(GriffonApplication application) Called when the shutdown sequence continues
void	registerArtifactHandler(ArtifactHandler artifactHandler) Registers an ArtifactHandler by type.
void	unregisterArtifactHandler(ArtifactHandler artifactHandler) Removes an ArtifactHandler by type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ERROR_ARTIFACT_HANDLER_NULL

protected static final String ERROR_ARTIFACT_HANDLER_NULL

See Also:

Constant Field Values

Constructor Detail

AbstractArtifactManager

public AbstractArtifactManager()

Method Detail

getArtifactHandlers

@Nonnull
protected Map<String,ArtifactHandler> getArtifactHandlers()

loadArtifactMetadata

public final void loadArtifactMetadata(@Nonnull
                                       Injector<?> injector)

Description copied from interface: ArtifactManager

Reads the artifacts definitions file from the classpath.

Should call initialize() on artifact handlers if there are any registered already.

Specified by:

loadArtifactMetadata in interface ArtifactManager

getAllTypes

@Nonnull
public Set<String> getAllTypes()

Description copied from interface: ArtifactManager

Finds all supported artifact types.

Specified by:

getAllTypes in interface ArtifactManager

Returns:

a Set of all available artifact types. Never returns null.

newInstance

@Nonnull
public <A extends GriffonArtifact> A newInstance(@Nonnull
                                                          GriffonClass griffonClass)

Description copied from interface: ArtifactManager

Creates a new instance of the specified class and type.
Triggers the ApplicationEvent.NEW_INSTANCE with the following parameters

• clazz - the Class of the object
• instance -> the object that was created

Specified by:

newInstance in interface ArtifactManager

Parameters:

griffonClass - the GriffonClass for which an instance must be created

Returns:

a newly instantiated object of type clazz. Implementations must be sure to trigger an event of type ApplicationEvent.NEW_INSTANCE.

newInstance

@Nonnull
public <A extends GriffonArtifact> A newInstance(@Nonnull
                                                          Class<A> clazz)

Description copied from interface: ArtifactManager

Creates a new instance of the specified class and type.
Triggers the ApplicationEvent.NEW_INSTANCE with the following parameters

• clazz - the Class of the object
• instance -> the object that was created

Specified by:

newInstance in interface ArtifactManager

Parameters:

clazz - the Class for which an instance must be created

Returns:

a newly instantiated object of type clazz. Implementations must be sure to trigger an event of type ApplicationEvent.NEW_INSTANCE.

doLoadArtifactMetadata

@Nonnull
protected abstract Map<String,List<Class<? extends GriffonArtifact>>> doLoadArtifactMetadata()

registerArtifactHandler

public void registerArtifactHandler(@Nonnull
                                    ArtifactHandler artifactHandler)

Description copied from interface: ArtifactManager

Registers an ArtifactHandler by type.

Should call initialize() on the handler.

Specified by:

registerArtifactHandler in interface ArtifactManager

Parameters:

artifactHandler - an ArtifactHandler

unregisterArtifactHandler

public void unregisterArtifactHandler(@Nonnull
                                      ArtifactHandler artifactHandler)

Description copied from interface: ArtifactManager

Removes an ArtifactHandler by type.

Specified by:

unregisterArtifactHandler in interface ArtifactManager

Parameters:

artifactHandler - an ArtifactHandler

isArtifactTypeSupported

protected boolean isArtifactTypeSupported(@Nonnull
                                          String type)

findGriffonClass

@Nullable
public GriffonClass findGriffonClass(@Nonnull
                                               String name,
                                               @Nonnull
                                               String type)

Description copied from interface: ArtifactManager

Finds an artifact by name and type.

Example: findGriffonClass("Book", "controller") will return an artifact class that describes BookController.

Specified by:

findGriffonClass in interface ArtifactManager

Parameters:

name - the name of the artifact, e.g. 'Book'

type - the type of the artifact, e.g. 'controller'

Returns:

the GriffonClass associated with the artifact is there's a match, null otherwise.

findGriffonClass

@Nullable
public GriffonClass findGriffonClass(@Nonnull
                                               Class<? extends GriffonArtifact> clazz,
                                               @Nonnull
                                               String type)

Description copied from interface: ArtifactManager

Finds an artifact by class and type.

Example: findGriffonClass(BookController, "controller") will return an artifact class that describes BookController.

Specified by:

findGriffonClass in interface ArtifactManager

Parameters:

clazz - the name of the artifact, e.g. com.acme.BookController

type - the type of the artifact, e.g. 'controller'

Returns:

the GriffonClass associated with the artifact is there's a match, null otherwise.

findGriffonClass

@Nullable
public <A extends GriffonArtifact> GriffonClass findGriffonClass(@Nonnull
                                                                           A artifact)

Description copied from interface: ArtifactManager

Finds an artifact by class.

Example: findGriffonClass(aBookControllerInstance) will return an artifact class that describes BookController.

Specified by:

findGriffonClass in interface ArtifactManager

Parameters:

artifact - an artifact instance

Returns:

the GriffonClass associated with the artifact is there's a match, null otherwise.

findGriffonClass

@Nullable
public GriffonClass findGriffonClass(@Nonnull
                                               Class<? extends GriffonArtifact> clazz)

Description copied from interface: ArtifactManager

Finds an artifact by class.

Example: findGriffonClass(BookController) will return an artifact class that describes BookController.

Specified by:

findGriffonClass in interface ArtifactManager

Parameters:

clazz - a Class instance

Returns:

the GriffonClass associated with the artifact is there's a match, null otherwise.

findGriffonClass

@Nullable
public GriffonClass findGriffonClass(@Nonnull
                                               String fqClassName)

Description copied from interface: ArtifactManager

Finds an artifact by name.

Example: findGriffonClass("BookController") will return an artifact class that describes BookController.

Specified by:

findGriffonClass in interface ArtifactManager

Parameters:

fqClassName - full qualified class name

Returns:

the GriffonClass associated with the artifact is there's a match, null otherwise.

getClassesOfType

@Nonnull
public List<GriffonClass> getClassesOfType(@Nonnull
                                                    String type)

Description copied from interface: ArtifactManager

Finds all artifacts of an specific type.

Example: getClassesOfType("controller") will return all artifact classes that describe controllers.

Specified by:

getClassesOfType in interface ArtifactManager

Parameters:

type - an artifact type, e.g. 'controller'

Returns:

a List of matching artifacts or an empty List if no match. Never returns null.

getAllClasses

@Nonnull
public List<GriffonClass> getAllClasses()

Description copied from interface: ArtifactManager

Finds all artifact classes.

Specified by:

getAllClasses in interface ArtifactManager

Returns:

a List of all available GriffonClass instances. Never returns null.

canShutdown

public boolean canShutdown(@Nonnull
                           GriffonApplication application)

Description copied from interface: ShutdownHandler

Asks this handler if the application's shutdown sequence can proceed or not.

Return false if the shutdown sequence must be aborted.

Specified by:

canShutdown in interface ShutdownHandler

Parameters:

application - the current running application

Returns:

true if the shutdown sequence can proceed, false otherwise

onShutdown

public void onShutdown(@Nonnull
                       GriffonApplication application)

Description copied from interface: ShutdownHandler

Called when the shutdown sequence continues

Specified by:

onShutdown in interface ShutdownHandler

Parameters:

application - the current running application

isClassOfType

protected <A extends GriffonArtifact> boolean isClassOfType(@Nonnull
                                                            String type,
                                                            @Nonnull
                                                            Class<A> clazz)