Package jetbrains.mps.project.facets

Interface TestsFacet

All Superinterfaces:

GenerationTargetFacet, SModuleFacet

All Known Implementing Classes:

TestsFacetImpl

public interface TestsFacet
extends SModuleFacet, GenerationTargetFacet

This facet implies tests are generally written in Java (MPS compiles files from getTestsOutputPath())

Field Summary

Fields

Modifier and Type	Field	Description
static String	FACET_TYPE

Method Summary

Modifier and Type	Method	Description
default IFile	getOutputCacheLocation(SModel model)	Facilitates keeping related generated artifacts, e.g.
default IFile	getOutputCacheRoot()
default IFile	getOutputCacheRoot(SModel model)
default IFile	getOutputLocation(SModel model)	Location for output files.
default IFile	getOutputRoot(SModel model)	XXX See javadoc for JavaModuleFacet#getOutputRoot().
IFile	getTestsOutputPath()

Methods inherited from interface org.jetbrains.mps.openapi.module.SModuleFacet

getFacetType, getModule, load, save

Field Detail

FACET_TYPE

static final String FACET_TYPE

See Also:

Constant Field Values

Method Detail

getTestsOutputPath

@Nullable
IFile getTestsOutputPath()

Returns:

test output folder, if there is one. Otherwise returns null.

getOutputCacheRoot

@Nullable
default IFile getOutputCacheRoot()

See Also:

JavaModuleFacet.getOutputCacheRoot()

getOutputRoot

@Nullable
default IFile getOutputRoot(@NotNull
                            SModel model)

Description copied from interface: GenerationTargetFacet

XXX See javadoc for JavaModuleFacet#getOutputRoot(). Perhaps, with the rise of textgen-controlled location, GTF shall tell root only and cease answering getOutputLocation()?

Specified by:

getOutputRoot in interface GenerationTargetFacet

Parameters:

model - model of a module this facet is associated with

Returns:

FS location where generated files for the model go, same or ancestor of GenerationTargetFacet.getOutputLocation(SModel) value, or null if this facet doesn't manage output of the model

getOutputCacheRoot

@Nullable
default IFile getOutputCacheRoot(@NotNull
                                 SModel model)

Specified by:

getOutputCacheRoot in interface GenerationTargetFacet

Parameters:

model - model of a module this facet is associated with

Returns:

FS location where auxiliary generated model files go, same or ancestor of GenerationTargetFacet.getOutputCacheLocation(SModel) value, or null if this facet doesn't manage output of the model

getOutputLocation

@Nullable
default IFile getOutputLocation(@NotNull
                                SModel model)

Description copied from interface: GenerationTargetFacet

Location for output files. Generally, shall not be nullable, but would like to give implementors freedom to imply own restrictions (and it's safer to override with NotNull than vice versa).

Specified by:

getOutputLocation in interface GenerationTargetFacet

Parameters:

model - model of a module this facet is associated with

Returns:

FS location where generated files for the model go (not necessarily unique for the model, models may share one, unless otherwise noted by implementation)

getOutputCacheLocation

@Nullable
default IFile getOutputCacheLocation(@NotNull
                                     SModel model)

Description copied from interface: GenerationTargetFacet

Facilitates keeping related generated artifacts, e.g. descriptor, index, debug-related information, which is auxiliary to primary generation artifacts residing in GenerationTargetFacet.getOutputLocation(SModel)

Specified by:

getOutputCacheLocation in interface GenerationTargetFacet

Parameters:

model - model of a module this facet is associated with

Returns:

FS location for auxiliary generated files