org.eclipse.tigerstripe
Class API

java.lang.Object
  extended by org.eclipse.tigerstripe.API

public class API
extends java.lang.Object

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:

The API contains 2 major entry points:

Since:
0.3
Author:
Eric Dillon

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

PROJECT_LOCATOR_FACILITY

public static final java.lang.String PROJECT_LOCATOR_FACILITY
This is a property that can be set on the API when looking up project references. If no locator is set, a default locator implementation is provided instead

See Also:
Constant Field Values
Method Detail

getDefaultProjectSession

public static org.eclipse.tigerstripe.internal.api.project.IProjectSession getDefaultProjectSession()
                                                                                             throws org.eclipse.tigerstripe.internal.api.TigerstripeLicenseException
Returns the default Project Session for this API. There is only 1 project session per instance of Tigerstripe Workbench. (Singleton) This is the main entry point in the API to access project level information.

Returns:
IProjectSession - the default project session.
Throws:
org.eclipse.tigerstripe.internal.api.TigerstripeLicenseException

getDefaultArtifactMetadataSession

public static org.eclipse.tigerstripe.internal.api.model.IArtifactMetadataSession getDefaultArtifactMetadataSession()
Returns the default IArtifactMetadataSession. This is not fully supported in 1.2 yet, but is intended to provide access to the Tigerstripe Metamodel that's deployed. This part of the API should be consider un-stable as of Tigerstripe Workbench 1.2

Returns:
IArtifactMetadataSession - the default IArtifactMetadataSession (Singleton)

getFacility

public static org.eclipse.tigerstripe.internal.api.utils.IAPIFacility getFacility(java.lang.String facilityID)
                                                                           throws TigerstripeException
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. These basically implement a call-back mechanism so the API has effectively no dependency on any given IDE This part of the API should be consider un-stable as of Tigerstripe Workbench 1.2

Throws:
TigerstripeException

registerFacility

public static void registerFacility(java.lang.String facilityID,
                                    org.eclipse.tigerstripe.internal.api.utils.IAPIFacility facility)
                             throws TigerstripeException
Allows a client of this API to register its own facilities

Parameters:
facilityID -
facility -
Throws:
TigerstripeException

getIWorkbenchProfileSession

public static IWorkbenchProfileSession getIWorkbenchProfileSession()
Returns the default IWorkbenchProfileSession (Singleton) which provides access to the Active Profile and to the create/edit additional profiles programmatically.

Returns:
IWorkbenchProfileSession - the default IWorkbenchProfileSession (Singleton)

getIContractSession

public static org.eclipse.tigerstripe.internal.api.contract.IContractSession getIContractSession()

getIDiagramRenderingSession

public static org.eclipse.tigerstripe.internal.api.rendering.IDiagramRenderingSession getIDiagramRenderingSession()