org.codehaus.griffon.runtime.core.mvc

Class AbstractMVCGroup

java.lang.Object

org.codehaus.griffon.runtime.core.mvc.AbstractMVCGroup

All Implemented Interfaces:

MVCGroup

Direct Known Subclasses:

DefaultMVCGroup

public abstract class AbstractMVCGroup
extends Object
implements MVCGroup

Base implementation of the MVCGroup interface

Since:

2.0.0

Author:

Andres Almiray

Field Summary

Fields

Modifier and Type	Field and Description
protected MVCGroupConfiguration	configuration
protected Map<String,Object>	members
protected MVCGroupManager	mvcGroupManager
protected String	mvcId

Constructor Summary

Constructors

Constructor and Description
AbstractMVCGroup(MVCGroupManager mvcGroupManager, MVCGroupConfiguration configuration, String mvcId, Map<String,Object> members)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkIfAlive()
void	destroy() Destroys the current group.
MVCGroupConfiguration	getConfiguration() Returns the configuration of this group.
GriffonController	getController() Returns the Controller portion of this group.
Object	getMember(String name) Returns the specified member type.
Map<String,Object>	getMembers() Returns a read-only view of all instance members.
GriffonModel	getModel() Returns the Model portion of this group.
MVCGroupManager	getMvcGroupManager()
String	getMvcId() Returns the id of the group.
String	getMvcType() Returns the type of this group as set in the application's configuration.
GriffonView	getView() Returns the View portion of this group.
boolean	isAlive() Returns whether this group has been destroyed or not.

Methods inherited from class java.lang.Object

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

Field Detail

mvcGroupManager

protected final MVCGroupManager mvcGroupManager

configuration

protected final MVCGroupConfiguration configuration

mvcId

protected final String mvcId

members

protected final Map<String,Object> members

Constructor Detail

AbstractMVCGroup

public AbstractMVCGroup(@Nonnull
                MVCGroupManager mvcGroupManager,
                @Nonnull
                MVCGroupConfiguration configuration,
                @Nullable
                String mvcId,
                @Nonnull
                Map<String,Object> members)

Method Detail

getMvcGroupManager

@Nonnull
public MVCGroupManager getMvcGroupManager()

getConfiguration

@Nonnull
public MVCGroupConfiguration getConfiguration()

Description copied from interface: MVCGroup

Returns the configuration of this group.

Specified by:

getConfiguration in interface MVCGroup

Returns:

the configuration used to instantiate this group.

getMvcType

@Nonnull
public String getMvcType()

Description copied from interface: MVCGroup

Returns the type of this group as set in the application's configuration.

Specified by:

getMvcType in interface MVCGroup

Returns:

the type of the group

getMvcId

@Nonnull
public String getMvcId()

Description copied from interface: MVCGroup

Returns the id of the group. Ids are used to uniquely identify a group instance.

Specified by:

getMvcId in interface MVCGroup

Returns:

the id of this group.

getModel

@Nullable
public GriffonModel getModel()

Description copied from interface: MVCGroup

Returns the Model portion of this group.

Specified by:

getModel in interface MVCGroup

Returns:

a GriffonModel instance if the group has a model member, null otherwise

getView

@Nullable
public GriffonView getView()

Description copied from interface: MVCGroup

Returns the View portion of this group.

Specified by:

getView in interface MVCGroup

Returns:

a GriffonView instance if the group has a view member, null otherwise

getController

@Nullable
public GriffonController getController()

Description copied from interface: MVCGroup

Returns the Controller portion of this group.

Specified by:

getController in interface MVCGroup

Returns:

a GriffonController instance if the group has a controller member, null otherwise

getMember

@Nullable
public Object getMember(@Nonnull
                        String name)

Description copied from interface: MVCGroup

Returns the specified member type.

Specified by:

getMember in interface MVCGroup

Parameters:

name - the type of member to retrieve

Returns:

the selected MVC member if a match is found, null otherwise

getMembers

@Nonnull
public Map<String,Object> getMembers()

Description copied from interface: MVCGroup

Returns a read-only view of all instance members.

Specified by:

getMembers in interface MVCGroup

Returns:

an unmodifiable Map view of all members.

destroy

public void destroy()

Description copied from interface: MVCGroup

Destroys the current group. Should only be called once.

Specified by:

destroy in interface MVCGroup

isAlive

public boolean isAlive()

Description copied from interface: MVCGroup

Returns whether this group has been destroyed or not.

Specified by:

isAlive in interface MVCGroup

Returns:

true if the group has not been destroyed yet, false otherwise

checkIfAlive

protected void checkIfAlive()