griffon.core.mvc

Interface MVCGroupManager

All Superinterfaces:

MVCHandler

All Known Implementing Classes:

AbstractMVCGroupManager, DefaultMVCGroupManager, GroovyAwareMVCGroupManager

public interface MVCGroupManager
extends MVCHandler

Manages the configuration and instantiation of MVC groups.

Since:

2.0.0

Author:

Andres Almiray

Method Summary

Modifier and Type	Method and Description
void	addConfiguration(MVCGroupConfiguration configuration)
MVCGroupConfiguration	cloneMVCGroupConfiguration(String mvcType, Map<String,Object> config) Clones an existing MVCGroupConfiguration, optionally overriding additional config values.
MVCGroupConfiguration	findConfiguration(String mvcType)
<C extends GriffonController> C	findController(String name, Class<C> type) Finds a named controller.
MVCGroup	findGroup(String mvcId)
<M extends GriffonModel> M	findModel(String name, Class<M> type) Finds a named model.
<V extends GriffonView> V	findView(String name, Class<V> type) Finds a named view.
GriffonApplication	getApplication()
MVCGroup	getAt(String mvcId)
Map<String,MVCGroupConfiguration>	getConfigurations()
<C extends GriffonController> C	getController(String name, Class<C> type) Finds a named controller.
Map<String,? extends GriffonController>	getControllers() Returns all currently available controller instances, keyed by group name.
Map<String,MVCGroup>	getGroups()
<M extends GriffonModel> M	getModel(String name, Class<M> type) Finds a named model.
Map<String,? extends GriffonModel>	getModels() Returns all currently available model instances, keyed by group name.
<V extends GriffonView> V	getView(String name, Class<V> type) Finds a named view.
Map<String,? extends GriffonView>	getViews() Returns all currently available view instances, keyed by group name.
void	initialize(Map<String,MVCGroupConfiguration> configurations) Initializes this manager with the group configurations provided by the application and addons.
MVCGroup	newMVCGroup(MVCGroupConfiguration configuration, String mvcId, Map<String,Object> members) Creates a new MVCGroup instance.
MVCGroupConfiguration	newMVCGroupConfiguration(String mvcType, Map<String,String> members, Map<String,Object> config) Creates an MVCConfiguration instance with the given arguments.
void	removeConfiguration(MVCGroupConfiguration configuration)
void	removeConfiguration(String name)

Methods inherited from interface griffon.core.mvc.MVCHandler

createMVC, createMVC, createMVC, createMVC, createMVC, createMVC, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, createMVCGroup, destroyMVCGroup, withMVC, withMVC, withMVC, withMVC, withMVC, withMVC, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup, withMVCGroup

Method Detail

newMVCGroupConfiguration

@Nonnull
MVCGroupConfiguration newMVCGroupConfiguration(@Nonnull
                                                        String mvcType,
                                                        @Nonnull
                                                        Map<String,String> members,
                                                        @Nonnull
                                                        Map<String,Object> config)

Creates an MVCConfiguration instance with the given arguments.

Parameters:

mvcType - the name of the MVC group

members - members of the group

config - additional configuration required by the group

Returns:

a ready-to-use MVCGroupConfiguration instance

cloneMVCGroupConfiguration

@Nonnull
MVCGroupConfiguration cloneMVCGroupConfiguration(@Nonnull
                                                          String mvcType,
                                                          @Nonnull
                                                          Map<String,Object> config)

Clones an existing MVCGroupConfiguration, optionally overriding additional config values.

Parameters:

mvcType - the name of the configuration to clone

config - additional config parameters to be set on the configuration

Returns:

a ready-to-use MVCGroupConfiguration instance

newMVCGroup

@Nonnull
MVCGroup newMVCGroup(@Nonnull
                              MVCGroupConfiguration configuration,
                              @Nullable
                              String mvcId,
                              @Nonnull
                              Map<String,Object> members)

Creates a new MVCGroup instance.

Parameters:

configuration - the configuration of the group

mvcId - the id to use for the group

members - the instance members of the group

Returns:

a ready-to-use MVCGroup instance

initialize

void initialize(@Nonnull
                Map<String,MVCGroupConfiguration> configurations)

Initializes this manager with the group configurations provided by the application and addons.

Parameters:

configurations - available group configurations

addConfiguration

void addConfiguration(@Nonnull
                      MVCGroupConfiguration configuration)

removeConfiguration

void removeConfiguration(@Nonnull
                         MVCGroupConfiguration configuration)

removeConfiguration

void removeConfiguration(@Nonnull
                         String name)

getConfigurations

@Nonnull
Map<String,MVCGroupConfiguration> getConfigurations()

getGroups

@Nonnull
Map<String,MVCGroup> getGroups()

findConfiguration

@Nonnull
MVCGroupConfiguration findConfiguration(@Nonnull
                                                 String mvcType)

findGroup

@Nullable
MVCGroup findGroup(@Nonnull
                             String mvcId)

getAt

@Nullable
MVCGroup getAt(@Nonnull
                         String mvcId)

getModels

@Nonnull
Map<String,? extends GriffonModel> getModels()

Returns all currently available model instances, keyed by group name.

Returns:

a Map of all currently instantiated models.

getViews

@Nonnull
Map<String,? extends GriffonView> getViews()

Returns all currently available view instances, keyed by group name.

Returns:

a Map of all currently instantiated views.

getControllers

@Nonnull
Map<String,? extends GriffonController> getControllers()

Returns all currently available controller instances, keyed by group name.

Returns:

a Map of all currently instantiated controllers.

getApplication

GriffonApplication getApplication()

getController

@Nonnull
<C extends GriffonController> C getController(@Nonnull
                                                       String name,
                                                       @Nonnull
                                                       Class<C> type)
                                                throws ArtifactNotFoundException

Finds a named controller.

Parameters:

name - the name of the group that holds the controller

type - the type of the controller

Returns:

the controller instance if found

Throws:

ArtifactNotFoundException - if the named controller could not be found

Since:

2.1.0

getModel

@Nonnull
<M extends GriffonModel> M getModel(@Nonnull
                                             String name,
                                             @Nonnull
                                             Class<M> type)
                                      throws ArtifactNotFoundException

Finds a named model.

Parameters:

name - the name of the group that holds the model

type - the type of the model

Returns:

the model instance if found

Throws:

ArtifactNotFoundException - if the named model could not be found

Since:

2.1.0

getView

@Nonnull
<V extends GriffonView> V getView(@Nonnull
                                           String name,
                                           @Nonnull
                                           Class<V> type)
                                    throws ArtifactNotFoundException

Finds a named view.

Parameters:

name - the name of the group that holds the view

type - the type of the view

Returns:

the view instance if found

Throws:

ArtifactNotFoundException - if the named view could not be found

Since:

2.1.0

findController

@Nullable
<C extends GriffonController> C findController(@Nonnull
                                                         String name,
                                                         @Nonnull
                                                         Class<C> type)

Finds a named controller.

Parameters:

name - the name of the group that holds the controller

type - the type of the controller

Returns:

the controller instance if found

Since:

2.1.0

findModel

@Nullable
<M extends GriffonModel> M findModel(@Nonnull
                                               String name,
                                               @Nonnull
                                               Class<M> type)

Finds a named model.

Parameters:

name - the name of the group that holds the model

type - the type of the model

Returns:

the model instance if found

Since:

2.1.0

findView

@Nullable
<V extends GriffonView> V findView(@Nonnull
                                             String name,
                                             @Nonnull
                                             Class<V> type)

Finds a named view.

Parameters:

name - the name of the group that holds the view

type - the type of the view

Returns:

the view instance if found

Since:

2.1.0