org.eclipse.tigerstripe.project
Interface IAbstractTigerstripeProject

All Known Subinterfaces:
ITigerstripeProject

public interface IAbstractTigerstripeProject

Top level handle for any Tigerstripe project

Since:
1.2
Author:
Eric Dillon

Method Summary
 void doSave()
           
 boolean equals(java.lang.Object obj)
          A proper comparison mechanism for IAbstractTigerstripeProject
 boolean exists()
           
 java.io.File getBaseDir()
          Base directory for the project
 java.lang.String getDescriptorFilename()
          Returns the descriptor filename for this type of Project
 IProjectDetails getIProjectDetails()
           
 IProjectDetails getProjectDetails()
           
 java.lang.String getProjectLabel()
          The project label is a contextual name use to identify the project.
 java.net.URI getURI()
           
 void validate(org.eclipse.tigerstripe.internal.api.project.ITigerstripeVisitor visitor)
           
 

Method Detail

getProjectLabel

java.lang.String getProjectLabel()
The project label is a contextual name use to identify the project. Typically, within most IDEs projects have a local name within the workspace, this is it! Internally, an IProjectLocator facility is used to determine the value

Returns:

getURI

java.net.URI getURI()

validate

void validate(org.eclipse.tigerstripe.internal.api.project.ITigerstripeVisitor visitor)
              throws TigerstripeException
Throws:
TigerstripeException

getProjectDetails

IProjectDetails getProjectDetails()
                                  throws TigerstripeException
Throws:
TigerstripeException

doSave

void doSave()
            throws TigerstripeException
Throws:
TigerstripeException

equals

boolean equals(java.lang.Object obj)
A proper comparison mechanism for IAbstractTigerstripeProject

Overrides:
equals in class java.lang.Object
Parameters:
obj - - the other tigerstripe project to compare with
Returns:
true, if the project passed as an argument as the same class type and the same URI.

getDescriptorFilename

java.lang.String getDescriptorFilename()
Returns the descriptor filename for this type of Project

Returns:

exists

boolean exists()
Returns:
true if the project exists (i.e. a valid project descriptor was found in the handle)

getBaseDir

java.io.File getBaseDir()
Base directory for the project

Returns:

getIProjectDetails

IProjectDetails getIProjectDetails()
                                   throws TigerstripeException
Throws:
TigerstripeException