org.codehaus.griffon.runtime.core.mvc

Class AbstractMVCGroupConfiguration

java.lang.Object

org.codehaus.griffon.runtime.core.mvc.AbstractMVCGroupConfiguration

All Implemented Interfaces:

MVCGroupConfiguration

Direct Known Subclasses:

DefaultMVCGroupConfiguration

public abstract class AbstractMVCGroupConfiguration
extends java.lang.Object
implements MVCGroupConfiguration

Base implementation of the MVCGroupConfiguration interface

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	config
protected java.util.Map<java.lang.String,java.lang.String>	members
protected java.lang.String	mvcType

Constructor Summary

Constructors

Constructor and Description
AbstractMVCGroupConfiguration(java.lang.String mvcType, java.util.Map<java.lang.String,java.lang.String> members, java.util.Map<java.lang.String,java.lang.Object> config)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

members

protected final java.util.Map<java.lang.String,java.lang.String> members

config

protected final java.util.Map<java.lang.String,java.lang.Object> config

mvcType

protected final java.lang.String mvcType

Constructor Detail

AbstractMVCGroupConfiguration

public AbstractMVCGroupConfiguration(@Nonnull
                                     java.lang.String mvcType,
                                     @Nonnull
                                     java.util.Map<java.lang.String,java.lang.String> members,
                                     @Nonnull
                                     java.util.Map<java.lang.String,java.lang.Object> config)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMvcType

@Nonnull
public java.lang.String getMvcType()

Description copied from interface: MVCGroupConfiguration

Returns the type of this group.

Specified by:

getMvcType in interface MVCGroupConfiguration

Returns:

the type of the group.

getMembers

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

Description copied from interface: MVCGroupConfiguration

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

Specified by:

getMembers in interface MVCGroupConfiguration

Returns:

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

getConfig

@Nonnull
public java.util.Map<java.lang.String,java.lang.Object> getConfig()

Description copied from interface: MVCGroupConfiguration

Returns a Map with additional configuration for this group.

Specified by:

getConfig in interface MVCGroupConfiguration

Returns:

a Map with additional configuration for this group.

create

@Nonnull
public MVCGroup create()

Description copied from interface: MVCGroupConfiguration

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.

Specified by:

create in interface MVCGroupConfiguration

Returns:

a newly instantiated MVCGroup

create

@Nonnull
public MVCGroup create(@Nullable
                                java.lang.String mvcId)

Description copied from interface: MVCGroupConfiguration

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

Specified by:

create in interface MVCGroupConfiguration

Parameters:

mvcId - the id to assign to this group

Returns:

a newly instantiated MVCGroup

create

@Nonnull
public MVCGroup create(@Nonnull
                                java.util.Map<java.lang.String,java.lang.Object> args)

Description copied from interface: MVCGroupConfiguration

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

Specified by:

create in interface MVCGroupConfiguration

Parameters:

args - additional arguments sent to each member when initializing

Returns:

a newly instantiated MVCGroup

create

@Nonnull
public MVCGroup create(@Nullable
                                java.lang.String mvcId,
                                @Nonnull
                                java.util.Map<java.lang.String,java.lang.Object> args)

Description copied from interface: MVCGroupConfiguration

Creates a new MVCGroup instance based in this configuration.

Specified by:

create in interface MVCGroupConfiguration

Parameters:

mvcId - the id to assign to this group

args - additional arguments sent to each member when initializing

Returns:

a newly instantiated MVCGroup

instantiateMVCGroup

@Nonnull
protected abstract MVCGroup instantiateMVCGroup(@Nullable
                                                         java.lang.String mvcId,
                                                         @Nonnull
                                                         java.util.Map<java.lang.String,java.lang.Object> args)