griffon.core.artifact

Interface ArtifactManager

All Known Implementing Classes:

AbstractArtifactManager, DefaultArtifactManager

public interface ArtifactManager

Helper class capable of dealing with artifacts and their handlers.

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
static List<GriffonClass>	EMPTY_GRIFFON_CLASS_LIST

Method Summary

Modifier and Type	Method and Description
<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.
List<GriffonClass>	getClassesOfType(String type) Finds all artifacts of an specific type.
void	loadArtifactMetadata() 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	registerArtifactHandler(ArtifactHandler handler) Registers an ArtifactHandler by type.
void	unregisterArtifactHandler(ArtifactHandler handler) Removes an ArtifactHandler by type.

Field Detail

EMPTY_GRIFFON_CLASS_LIST

static final List<GriffonClass> EMPTY_GRIFFON_CLASS_LIST

Method Detail

registerArtifactHandler

void registerArtifactHandler(@Nonnull
                             ArtifactHandler handler)

Registers an ArtifactHandler by type.

Should call initialize() on the handler.

Parameters:

handler - an ArtifactHandler

unregisterArtifactHandler

void unregisterArtifactHandler(@Nonnull
                               ArtifactHandler handler)

Removes an ArtifactHandler by type.

Parameters:

handler - an ArtifactHandler

loadArtifactMetadata

void loadArtifactMetadata()

Reads the artifacts definitions file from the classpath.

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

findGriffonClass

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

Finds an artifact by name and type.

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

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
GriffonClass findGriffonClass(@Nonnull
                                        Class<? extends GriffonArtifact> clazz,
                                        @Nonnull
                                        String type)

Finds an artifact by class and type.

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

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
<A extends GriffonArtifact> GriffonClass findGriffonClass(@Nonnull
                                                                    A artifact)

Finds an artifact by class.

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

Parameters:

artifact - an artifact instance

Returns:

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

findGriffonClass

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

Finds an artifact by class.

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

Parameters:

clazz - a Class instance

Returns:

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

findGriffonClass

@Nullable
GriffonClass findGriffonClass(@Nonnull
                                        String fqClassName)

Finds an artifact by name.

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

Parameters:

fqClassName - full qualified class name

Returns:

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

getClassesOfType

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

Finds all artifacts of an specific type.

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

Parameters:

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

Returns:

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

getAllTypes

@Nonnull
Set<String> getAllTypes()

Finds all supported artifact types.

Returns:

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

Since:

2.2.0

getAllClasses

@Nonnull
List<GriffonClass> getAllClasses()

Finds all artifact classes.

Returns:

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

newInstance

@Nonnull
<A extends GriffonArtifact> A newInstance(@Nonnull
                                                   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

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.

Throws:

ArtifactNotFoundException - if there's no artifact configured matching the given criteria

newInstance

@Nonnull
<A extends GriffonArtifact> A newInstance(@Nonnull
                                                   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

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.

Throws:

ArtifactNotFoundException - if there's no artifact configured matching the given criteria