Package jetbrains.mps.extapi.module

Class ModuleFacetBase

java.lang.Object

jetbrains.mps.extapi.module.ModuleFacetBase

All Implemented Interfaces:

SModuleFacet

Direct Known Subclasses:

CustomGenerationModuleFacet, DumbIdeaPluginFacet, JavaModuleFacetImpl, TestsFacetImpl

public abstract class ModuleFacetBase
extends Object
implements SModuleFacet

Base class for all module facets.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ModuleFacetBase(String facetType)

Method Summary

Modifier and Type	Method	Description
void	attach()
protected void	checkNotRegistered()
void	dispose()
String	getFacetPresentation()
String	getFacetType()	Identity of the facet, see FacetsFacade.getFacetFactory(String)
SModule	getModule()	The owning module TODO @deprecated facet is supposed to be a simple primitive flags storage.
boolean	isRegistered()
void	load(Memento memento)	Allows the model root to read its previously saved configuration information
void	save(Memento memento)	Gives the module facet the opportunity to persist into the supplied memento whatever configuration information may be needed to restore the models in the future.
boolean	setModule(SModule module)	FIXME javadoc @return and do we need both setModule + attach? Returns null if the facet cannot work within the passed module.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleFacetBase

protected ModuleFacetBase(@NotNull
                          String facetType)

Method Detail

getFacetType

@NotNull
public final String getFacetType()

Description copied from interface: SModuleFacet

Identity of the facet, see FacetsFacade.getFacetFactory(String)

Specified by:

getFacetType in interface SModuleFacet

Returns:

kind of the facet

getFacetPresentation

public String getFacetPresentation()

getModule

@NotNull
public SModule getModule()

Description copied from interface: SModuleFacet

The owning module TODO @deprecated facet is supposed to be a simple primitive flags storage. To extend module functionality one has two more ways: TODO extend from one of the SModule subclasses or implement a custom aspect

Specified by:

getModule in interface SModuleFacet

setModule

public boolean setModule(SModule module)

FIXME javadoc @return and do we need both setModule + attach? Returns null if the facet cannot work within the passed module.

checkNotRegistered

protected void checkNotRegistered()

isRegistered

public boolean isRegistered()

attach

public void attach()

dispose

public void dispose()

save

public void save(Memento memento)

Description copied from interface: SModuleFacet

Gives the module facet the opportunity to persist into the supplied memento whatever configuration information may be needed to restore the models in the future.

Specified by:

save in interface SModuleFacet

load

public void load(Memento memento)

Description copied from interface: SModuleFacet

Allows the model root to read its previously saved configuration information

Specified by:

load in interface SModuleFacet