griffon.core.mvc

Interface MVCGroup

All Superinterfaces:

MVCHandler

All Known Subinterfaces:

TypedMVCGroup<M,V,C>

All Known Implementing Classes:

AbstractMVCGroup, AbstractTypedMVCGroup, DefaultMVCGroup, DelegatingMVCGroup, GroovyAwareMVCGroup

public interface MVCGroup
extends MVCHandler

Defines an MVC group and its contents

Since:

2.0.0

Author:

Andres Almiray

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys the current group.
Map<String,MVCGroup>	getChildrenGroups() Returns an immutable view of all children groups for which this group is a parent
MVCGroupConfiguration	getConfiguration() Returns the configuration of this group.
Context	getContext() Returns the context belonging to 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.
String	getMvcId() Returns the id of the group.
String	getMvcType() Returns the type of this group as set in the application's configuration.
MVCGroup	getParentGroup() Returns the parent MVCGroup of this group.
GriffonView	getView() Returns the View portion of this group.
boolean	isAlive() Returns whether this group has been destroyed or not.
void	notifyMVCGroupDestroyed(String mvcId) Notifies the group when another MVC group has been destroyed, potentially a child group.

Methods inherited from interface griffon.core.mvc.MVCHandler

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

Method Detail

getConfiguration

@Nonnull
MVCGroupConfiguration getConfiguration()

Returns the configuration of this group.

Returns:

the configuration used to instantiate this group.

getMvcType

@Nonnull
String getMvcType()

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

Returns:

the type of the group

getMvcId

@Nonnull
String getMvcId()

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

Returns:

the id of this group.

getModel

@Nullable
GriffonModel getModel()

Returns the Model portion of this group.

Returns:

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

Throws:

IllegalStateException - if the group has been destroyed already

getView

@Nullable
GriffonView getView()

Returns the View portion of this group.

Returns:

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

Throws:

IllegalStateException - if the group has been destroyed already

getController

@Nullable
GriffonController getController()

Returns the Controller portion of this group.

Returns:

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

Throws:

IllegalStateException - if the group has been destroyed already

getMember

@Nullable
Object getMember(@Nonnull
                           String name)

Returns the specified member type.

Parameters:

name - the type of member to retrieve

Returns:

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

Throws:

IllegalStateException - if the group has been destroyed already

getMembers

@Nonnull
Map<String,Object> getMembers()

Returns a read-only view of all instance members.

Returns:

an unmodifiable Map view of all members.

Throws:

IllegalStateException - if the group has been destroyed already

destroy

void destroy()

Destroys the current group. Should only be called once.

Throws:

IllegalStateException - if the group has been destroyed already

isAlive

boolean isAlive()

Returns whether this group has been destroyed or not.

Returns:

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

getContext

@Nonnull
Context getContext()

Returns the context belonging to this group.

Since:

2.2.0

getParentGroup

@Nullable
MVCGroup getParentGroup()

Returns the parent MVCGroup of this group.

The parent may be null if this is a top level MVC group.

Since:

2.2.0

getChildrenGroups

@Nonnull
Map<String,MVCGroup> getChildrenGroups()

Returns an immutable view of all children groups for which this group is a parent

Returns:

an immutable view of children groups, keyed by mvcId.

Since:

2.4.0

notifyMVCGroupDestroyed

void notifyMVCGroupDestroyed(@Nonnull
                             String mvcId)

Notifies the group when another MVC group has been destroyed, potentially a child group.

Parameters:

mvcId - the id of the group that has been destroyed

Since:

2.4.0