griffon.core.mvc

Interface MVCGroupConfiguration

All Known Implementing Classes:

AbstractMVCGroupConfiguration, DefaultMVCGroupConfiguration

public interface MVCGroupConfiguration

Holds the configuration of an MVC group

Since:

2.0.0

Author:

Andres Almiray

Method Summary

Methods

Modifier and Type	Method and Description
MVCGroup	create() Creates a new MVCGroup instance based in this configuration.
MVCGroup	create(Map<String,Object> args) Creates a new MVCGroup instance based in this configuration.
MVCGroup	create(String mvcId) Creates a new MVCGroup instance based in this configuration.
MVCGroup	create(String mvcId, Map<String,Object> args) Creates a new MVCGroup instance based in this configuration.
Map<String,Object>	getConfig() Returns a Map with additional configuration for this group.
Map<String,String>	getMembers() Returns a Map with the names of all members keyed by type.
String	getMvcType() Returns the type of this group.

Method Detail

getMvcType

@Nonnull
String getMvcType()

Returns the type of this group.

Returns:

the type of the group.

getMembers

@Nonnull
Map<String,String> getMembers()

Returns a Map with the names of all members keyed by type.

Returns:

a Map of all configured members as defined by the application's configuration or and addon contribution.

getConfig

@Nonnull
Map<String,Object> getConfig()

Returns a Map with additional configuration for this group.

Returns:

a Map with additional configuration for this group.

create

@Nonnull
MVCGroup create()

Creates a new MVCGroup instance based in this configuration. The group's id will should be set to the group's type and an empty Map should be used as the additional arguments.

Returns:

a newly instantiated MVCGroup

create

@Nonnull
MVCGroup create(@Nullable
                      String mvcId)

Creates a new MVCGroup instance based in this configuration. An empty Map should be used as the additional arguments.

Parameters:

mvcId - the id to assign to this group

Returns:

a newly instantiated MVCGroup

create

@Nonnull
MVCGroup create(@Nonnull
                      Map<String,Object> args)

Creates a new MVCGroup instance based in this configuration. The group's id will should be set to the group's type.

Parameters:

args - additional arguments sent to each member when initializing

Returns:

a newly instantiated MVCGroup

create

@Nonnull
MVCGroup create(@Nullable
                      String mvcId,
                      @Nonnull
                      Map<String,Object> args)

Creates a new MVCGroup instance based in this configuration.

Parameters:

mvcId - the id to assign to this group

args - additional arguments sent to each member when initializing

Returns:

a newly instantiated MVCGroup