|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.tigerstripe.API
public class API
The entry point for all interactions with the Tigerstripe API This is a singleton class that acts as the factory class for any Tigerstripe Project. Also, as the singleton is accessed, the TigerstripeLicense is checked. Throughout the Tigerstripe API, a set of patterns are used:
Field Summary | |
---|---|
static java.lang.String |
PROJECT_LOCATOR_FACILITY
This is a property that can be set on the API when looking up project references. |
Method Summary | |
---|---|
static org.eclipse.tigerstripe.internal.api.model.IArtifactMetadataSession |
getDefaultArtifactMetadataSession()
Returns the default IArtifactMetadataSession. |
static org.eclipse.tigerstripe.internal.api.project.IProjectSession |
getDefaultProjectSession()
Returns the default Project Session for this API. |
static org.eclipse.tigerstripe.internal.api.utils.IAPIFacility |
getFacility(java.lang.String facilityID)
To allow for better interaction between the IDE used on top of this API, the client of the API can register a set of utility objects that will be used if present by the API. |
static org.eclipse.tigerstripe.internal.api.contract.IContractSession |
getIContractSession()
|
static org.eclipse.tigerstripe.internal.api.rendering.IDiagramRenderingSession |
getIDiagramRenderingSession()
|
static IWorkbenchProfileSession |
getIWorkbenchProfileSession()
Returns the default IWorkbenchProfileSession (Singleton) which provides access to the Active Profile and to the create/edit additional profiles programmatically. |
static void |
registerFacility(java.lang.String facilityID,
org.eclipse.tigerstripe.internal.api.utils.IAPIFacility facility)
Allows a client of this API to register its own facilities |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PROJECT_LOCATOR_FACILITY
Method Detail |
---|
public static org.eclipse.tigerstripe.internal.api.project.IProjectSession getDefaultProjectSession() throws org.eclipse.tigerstripe.internal.api.TigerstripeLicenseException
org.eclipse.tigerstripe.internal.api.TigerstripeLicenseException
public static org.eclipse.tigerstripe.internal.api.model.IArtifactMetadataSession getDefaultArtifactMetadataSession()
public static org.eclipse.tigerstripe.internal.api.utils.IAPIFacility getFacility(java.lang.String facilityID) throws TigerstripeException
TigerstripeException
public static void registerFacility(java.lang.String facilityID, org.eclipse.tigerstripe.internal.api.utils.IAPIFacility facility) throws TigerstripeException
facilityID
- facility
-
TigerstripeException
public static IWorkbenchProfileSession getIWorkbenchProfileSession()
public static org.eclipse.tigerstripe.internal.api.contract.IContractSession getIContractSession()
public static org.eclipse.tigerstripe.internal.api.rendering.IDiagramRenderingSession getIDiagramRenderingSession()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |