Package jetbrains.mps.smodel.tempmodel

Class NaiveJavaModuleFacet

java.lang.Object

jetbrains.mps.smodel.tempmodel.NaiveJavaModuleFacet

All Implemented Interfaces:

GenerationTargetFacet, JavaModuleFacet, SModuleFacet

public final class NaiveJavaModuleFacet
extends Object
implements JavaModuleFacet

A simple java facet provided with two locations of source_gen and classes_gen Created by apyshkin on 12/7/17.

Field Summary

Fields inherited from interface jetbrains.mps.project.facets.JavaModuleFacet

FACET_TYPE

Constructor Summary

Constructors

Constructor	Description
NaiveJavaModuleFacet(AbstractModule owningModule, String sourceGen, String classesGen)

Method Summary

Modifier and Type	Method	Description
Set<String>	getAdditionalSourcePaths()
IFile	getClassesGen()
Set<String>	getClassPath()
String	getFacetType()	Identity of the facet, see FacetsFacade.getFacetFactory(String)
Set<String>	getLibraryClassPath()
SModule	getModule()	The owning module TODO @deprecated facet is supposed to be a simple primitive flags storage.
IFile	getOutputRoot()	PROVISIONAL Perhaps, worth moving to GenerationTargetFacet.
boolean	isCompileInMps()
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.mps.project.facets.JavaModuleFacet

getClassesLocation, getOutputCacheLocation, getOutputCacheRoot, getOutputCacheRoot, getOutputLocation, getOutputRoot

Constructor Detail

NaiveJavaModuleFacet

public NaiveJavaModuleFacet(@NotNull
                            AbstractModule owningModule,
                            @Nullable
                            String sourceGen,
                            @NotNull
                            String classesGen)

Method Detail

getFacetType

@NotNull
public 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

isCompileInMps

public boolean isCompileInMps()

Specified by:

isCompileInMps in interface JavaModuleFacet

getOutputRoot

@Nullable
public IFile getOutputRoot()

Description copied from interface: JavaModuleFacet

PROVISIONAL Perhaps, worth moving to GenerationTargetFacet. OTOH, don't see a reason to restrict output of the facet to single root Need one here for transition period to have default implementations for JavaModuleFacet.getOutputLocation(SModel) and JavaModuleFacet.getOutputCacheLocation(SModel) Perhaps, shall be private to JavaModuleFacetImpl (need to get rid of default implementations of the dependant methods first). Top location where all 'primary' output goes, generally bound to module location, although no assumption shall be made about that. Known as source_gen

Specified by:

getOutputRoot in interface JavaModuleFacet

Returns:

null if associated module doesn't allow generation.

getClassesGen

@NotNull
public IFile getClassesGen()

Specified by:

getClassesGen in interface JavaModuleFacet

Returns:

root folder where generated classes of any module's model reside, or null if associated module doesn't expect class files to be written. Note, although generated classes are part of classpath, this method is to access design-time location of generated classes, not that at deployment time. For deployed modules, this method may return null, while generated module classes would be available for classloading through JavaModuleFacet.getClassPath().

getLibraryClassPath

public Set<String> getLibraryClassPath()

Specified by:

getLibraryClassPath in interface JavaModuleFacet

getClassPath

public Set<String> getClassPath()

Specified by:

getClassPath in interface JavaModuleFacet

getAdditionalSourcePaths

public Set<String> getAdditionalSourcePaths()

Specified by:

getAdditionalSourcePaths in interface JavaModuleFacet

Returns:

extra locations with source files to compile along with module's own generated artifacts from JavaModuleFacet.getOutputRoot(), or empty collection.

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

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