org.eclipse.tigerstripe.workbench.project
Interface IDependency

public interface IDependency

A Tigerstripe Dependency represents a .tsm file that contains Artifacts that have been "exported to a module" so they can be shared, as a library, between other projects. Once a Dependency is attached to a Tigerstripe project, all the Artifacts contained in this dependency are available within the current project. NOTE: The path to a dependency is considered relative to the project it is being attached to.

Author:

Eric Dillon

Field Summary

static java.lang.String	DEFAULT_CORE_MODEL_DEPENDENCY Default Dependency required on all projects This is to be compared with the module ID.
static java.lang.String	EXTENSION Extension for a Tigerstripe module (JAR) file *

Method Summary

org.eclipse.tigerstripe.workbench.internal.api.modules.IModuleHeader	getIModuleHeader()
IProjectDetails	getIProjectDetails()
java.lang.String	getPath() The relative path to this dependency
boolean	isValid() Whether this is a valid dependency or not This is equivalent to isValid(null)
boolean	isValid(IProgressMonitor monitor) Whether this is a valid dependency or not
org.eclipse.tigerstripe.workbench.internal.api.modules.ITigerstripeModuleProject	makeModuleProject(ITigerstripeModelProject containingProject) Make module project
org.eclipse.tigerstripe.workbench.internal.api.modules.IModuleHeader	parseIModuleHeader() This is a minimalistic method that is only intended to be used by the GUI, so the whole module doesn't have to be parsed to provide feedback to the user.
IProjectDetails	parseIProjectDetails() This is a minimalistic method that is only intended to be used by the GUI, so the whole module doesn't have to be parsed to provide feedback to the user.

Field Detail

EXTENSION

static final java.lang.String EXTENSION

Extension for a Tigerstripe module (JAR) file *

See Also:

Constant Field Values

DEFAULT_CORE_MODEL_DEPENDENCY

static final java.lang.String DEFAULT_CORE_MODEL_DEPENDENCY

Default Dependency required on all projects This is to be compared with the module ID.

Since:

1.0.3

See Also:

Constant Field Values

Method Detail

getIProjectDetails

IProjectDetails getIProjectDetails()

getIModuleHeader

org.eclipse.tigerstripe.workbench.internal.api.modules.IModuleHeader getIModuleHeader()

parseIModuleHeader

org.eclipse.tigerstripe.workbench.internal.api.modules.IModuleHeader parseIModuleHeader()
                                                                                        throws org.eclipse.tigerstripe.workbench.internal.core.module.InvalidModuleException

This is a minimalistic method that is only intended to be used by the GUI, so the whole module doesn't have to be parsed to provide feedback to the user.

Returns:

Throws:

org.eclipse.tigerstripe.workbench.internal.core.module.InvalidModuleException

parseIProjectDetails

IProjectDetails parseIProjectDetails()
                                     throws org.eclipse.tigerstripe.workbench.internal.core.module.InvalidModuleException

This is a minimalistic method that is only intended to be used by the GUI, so the whole module doesn't have to be parsed to provide feedback to the user.

Returns:

Throws:

org.eclipse.tigerstripe.workbench.internal.core.module.InvalidModuleException

getPath

java.lang.String getPath()

The relative path to this dependency

Returns:

the relative path from the project is attached to (or "to be" attached to).

isValid

boolean isValid(IProgressMonitor monitor)

Whether this is a valid dependency or not

Returns:

isValid

boolean isValid()

Whether this is a valid dependency or not This is equivalent to isValid(null)

Returns:

makeModuleProject

org.eclipse.tigerstripe.workbench.internal.api.modules.ITigerstripeModuleProject makeModuleProject(ITigerstripeModelProject containingProject)
                                                                                                   throws TigerstripeException

Make module project

Throws:

TigerstripeException