org.eclipse.tigerstripe.project
Interface ITigerstripeProject

All Superinterfaces:
IAbstractTigerstripeProject

public interface ITigerstripeProject
extends IAbstractTigerstripeProject

Handle on a Tigerstripe Project

Since:
0.3
Author:
Eric Dillon

Method Summary
 void addDependencies(IDependency[] dependencies, boolean updateCache, org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
           
 void addDependencies(IDependency[] dependencies, org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
          This is equivalent to addDependencies( dependencies, true )
 void addDependency(IDependency dependency, boolean updateCache, org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
           
 void addDependency(IDependency dependency, org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
          This is equivalent to addDependency(dependency, true)
 void addFacetReference(org.eclipse.tigerstripe.internal.api.contract.segment.IFacetReference facetRef)
           
 void addProjectChangeListener(org.eclipse.tigerstripe.internal.api.project.IProjectChangeListener listener)
           
 void addReferencedProject(ITigerstripeProject project)
           
 void addReferencedProjects(ITigerstripeProject[] project)
           
 void generate(org.eclipse.tigerstripe.internal.api.project.ITigerstripeVisitor visitor)
           
 org.eclipse.tigerstripe.internal.api.contract.segment.IFacetReference getActiveFacet()
           
 java.lang.String getAdvancedProperty(java.lang.String property)
           
 java.lang.String getAdvancedProperty(java.lang.String property, java.lang.String defaultValue)
           
 org.eclipse.tigerstripe.internal.api.model.IArtifactManagerSession getArtifactManagerSession()
          Returns the artifact manager session for this Tigerstripe project.
 java.lang.String getBaseRepository()
           
 org.eclipse.tigerstripe.internal.api.publish.IProjectCSVCreator getCSVCreator()
           
 IDependency[] getDependencies()
           
 org.eclipse.tigerstripe.internal.api.contract.segment.IFacetReference[] getFacetReferences()
           
 org.eclipse.tigerstripe.internal.api.model.IArtifactManagerSession getIArtifactManagerSession()
          Returns the artifact manager session for this Tigerstripe project.
 org.eclipse.tigerstripe.internal.api.project.IImportCheckpoint getImportCheckpoint()
          Returns the IImportCheckpoint for this project if it exists.
 IPluginReference[] getIPluginReferences()
          Returns the Plugin references defined in this project
 ITigerstripeProject[] getIReferencedProjects()
           
 org.eclipse.tigerstripe.internal.api.project.INameProvider getNameProvider()
          Provides a convenient default unique name provider for all artifacts being created.
 org.eclipse.tigerstripe.internal.api.modules.IModulePackager getPackager()
           
 IPluginReference[] getPluginReferences()
          Returns the Plugin references defined in this project
 IProjectDetails getProjectDetails()
           
 org.eclipse.tigerstripe.internal.api.publish.IProjectPublisher getPublisher()
           
 ITigerstripeProject[] getReferencedProjects()
           
 boolean hasDependency(IDependency dep)
          Returns true if this project has the given dependency in its dependencies list
 boolean hasReference(ITigerstripeProject project)
           
 IDependency makeIDependency(java.lang.String relativePath)
           
 org.eclipse.tigerstripe.internal.api.contract.segment.IFacetReference makeIFacetReference(java.lang.String projectRelativePath)
           
 org.eclipse.tigerstripe.internal.api.contract.segment.IFacetReference makeIFacetReference(java.net.URI facetURI)
           
 org.eclipse.tigerstripe.internal.api.contract.useCase.IUseCaseReference makeIUseCaseReference(java.lang.String projectRelativePath)
           
 void removeDependencies(IDependency[] dependencies, boolean updateCache, org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
           
 void removeDependencies(IDependency[] dependencies, org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
          This is equivalent to removeDependencies(dependencies, true)
 void removeDependency(IDependency dependency, boolean updateCache, org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
           
 void removeDependency(IDependency dependency, org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
          This is equivalent to removeDependency(dependency, true)
 void removeFacetReference(org.eclipse.tigerstripe.internal.api.contract.segment.IFacetReference facetRef)
           
 void removeProjectChangeListener(org.eclipse.tigerstripe.internal.api.project.IProjectChangeListener listener)
           
 void removeReferencedProject(ITigerstripeProject project)
           
 void removeReferencedProjects(ITigerstripeProject[] project)
           
 boolean requiresDescriptorUpgrade()
          Whether the descriptor needs to be upgraded to the correct compatibility level (and default values set properly).
 void resetActiveFacet()
           
 void setActiveFacet(org.eclipse.tigerstripe.internal.api.contract.segment.IFacetReference facet, org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
           
 void setAdvancedProperty(java.lang.String property, java.lang.String value)
           
 
Methods inherited from interface org.eclipse.tigerstripe.project.IAbstractTigerstripeProject
doSave, equals, exists, getBaseDir, getDescriptorFilename, getIProjectDetails, getProjectLabel, getURI, validate
 

Method Detail

getArtifactManagerSession

org.eclipse.tigerstripe.internal.api.model.IArtifactManagerSession getArtifactManagerSession()
                                                                                             throws TigerstripeException
Returns the artifact manager session for this Tigerstripe project.

Returns:
Throws:
TigerstripeException

getProjectDetails

IProjectDetails getProjectDetails()
                                  throws TigerstripeException
Specified by:
getProjectDetails in interface IAbstractTigerstripeProject
Throws:
TigerstripeException

generate

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

getPackager

org.eclipse.tigerstripe.internal.api.modules.IModulePackager getPackager()

getPublisher

org.eclipse.tigerstripe.internal.api.publish.IProjectPublisher getPublisher()

getCSVCreator

org.eclipse.tigerstripe.internal.api.publish.IProjectCSVCreator getCSVCreator()

getDependencies

IDependency[] getDependencies()
                              throws TigerstripeException
Throws:
TigerstripeException

removeDependency

void removeDependency(IDependency dependency,
                      boolean updateCache,
                      org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
                      throws TigerstripeException
Throws:
TigerstripeException

removeDependencies

void removeDependencies(IDependency[] dependencies,
                        boolean updateCache,
                        org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
                        throws TigerstripeException
Throws:
TigerstripeException

addDependency

void addDependency(IDependency dependency,
                   boolean updateCache,
                   org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
                   throws TigerstripeException
Throws:
TigerstripeException

addDependencies

void addDependencies(IDependency[] dependencies,
                     boolean updateCache,
                     org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
                     throws TigerstripeException
Throws:
TigerstripeException

removeDependency

void removeDependency(IDependency dependency,
                      org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
                      throws TigerstripeException
This is equivalent to removeDependency(dependency, true)

Parameters:
dependency -
Throws:
TigerstripeException

removeDependencies

void removeDependencies(IDependency[] dependencies,
                        org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
                        throws TigerstripeException
This is equivalent to removeDependencies(dependencies, true)

Parameters:
dependencies -
Throws:
TigerstripeException

addDependency

void addDependency(IDependency dependency,
                   org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
                   throws TigerstripeException
This is equivalent to addDependency(dependency, true)

Parameters:
dependency -
Throws:
TigerstripeException

addDependencies

void addDependencies(IDependency[] dependencies,
                     org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
                     throws TigerstripeException
This is equivalent to addDependencies( dependencies, true )

Parameters:
dependencies -
Throws:
TigerstripeException

makeIDependency

IDependency makeIDependency(java.lang.String relativePath)
                            throws TigerstripeException
Throws:
TigerstripeException

makeIFacetReference

org.eclipse.tigerstripe.internal.api.contract.segment.IFacetReference makeIFacetReference(java.net.URI facetURI)
                                                                                          throws TigerstripeException
Throws:
TigerstripeException

makeIFacetReference

org.eclipse.tigerstripe.internal.api.contract.segment.IFacetReference makeIFacetReference(java.lang.String projectRelativePath)
                                                                                          throws TigerstripeException
Throws:
TigerstripeException

makeIUseCaseReference

org.eclipse.tigerstripe.internal.api.contract.useCase.IUseCaseReference makeIUseCaseReference(java.lang.String projectRelativePath)
                                                                                              throws TigerstripeException
Throws:
TigerstripeException

addFacetReference

void addFacetReference(org.eclipse.tigerstripe.internal.api.contract.segment.IFacetReference facetRef)
                       throws TigerstripeException
Throws:
TigerstripeException

removeFacetReference

void removeFacetReference(org.eclipse.tigerstripe.internal.api.contract.segment.IFacetReference facetRef)
                          throws TigerstripeException
Throws:
TigerstripeException

getFacetReferences

org.eclipse.tigerstripe.internal.api.contract.segment.IFacetReference[] getFacetReferences()
                                                                                           throws TigerstripeException
Throws:
TigerstripeException

addProjectChangeListener

void addProjectChangeListener(org.eclipse.tigerstripe.internal.api.project.IProjectChangeListener listener)

removeProjectChangeListener

void removeProjectChangeListener(org.eclipse.tigerstripe.internal.api.project.IProjectChangeListener listener)

hasDependency

boolean hasDependency(IDependency dep)
                      throws TigerstripeException
Returns true if this project has the given dependency in its dependencies list

Parameters:
dep -
Returns:
Throws:
TigerstripeException - if the dep is invalid or the project is invalid.

addReferencedProject

void addReferencedProject(ITigerstripeProject project)
                          throws TigerstripeException
Throws:
TigerstripeException

addReferencedProjects

void addReferencedProjects(ITigerstripeProject[] project)
                           throws TigerstripeException
Throws:
TigerstripeException

removeReferencedProject

void removeReferencedProject(ITigerstripeProject project)
                             throws TigerstripeException
Throws:
TigerstripeException

removeReferencedProjects

void removeReferencedProjects(ITigerstripeProject[] project)
                              throws TigerstripeException
Throws:
TigerstripeException

hasReference

boolean hasReference(ITigerstripeProject project)
                     throws TigerstripeException
Throws:
TigerstripeException

setAdvancedProperty

void setAdvancedProperty(java.lang.String property,
                         java.lang.String value)
                         throws TigerstripeException
Throws:
TigerstripeException

requiresDescriptorUpgrade

boolean requiresDescriptorUpgrade()
                                  throws TigerstripeException
Whether the descriptor needs to be upgraded to the correct compatibility level (and default values set properly).

Returns:
Throws:
TigerstripeException

getImportCheckpoint

org.eclipse.tigerstripe.internal.api.project.IImportCheckpoint getImportCheckpoint()
                                                                                   throws TigerstripeException
Returns the IImportCheckpoint for this project if it exists. If no import was performed in this project, no IImportCheckpoint would exist and an exception would be thrown.

Returns:
Throws:
TigerstripeException

getPluginReferences

IPluginReference[] getPluginReferences()
                                       throws TigerstripeException
Returns the Plugin references defined in this project

Returns:
Throws:
TigerstripeException

getReferencedProjects

ITigerstripeProject[] getReferencedProjects()
                                            throws TigerstripeException
Throws:
TigerstripeException

getNameProvider

org.eclipse.tigerstripe.internal.api.project.INameProvider getNameProvider()
Provides a convenient default unique name provider for all artifacts being created.


getBaseRepository

java.lang.String getBaseRepository()
                                   throws TigerstripeException
Throws:
TigerstripeException

setActiveFacet

void setActiveFacet(org.eclipse.tigerstripe.internal.api.contract.segment.IFacetReference facet,
                    org.eclipse.tigerstripe.internal.api.utils.ITigerstripeProgressMonitor monitor)
                    throws TigerstripeException
Throws:
TigerstripeException

resetActiveFacet

void resetActiveFacet()
                      throws TigerstripeException
Throws:
TigerstripeException

getActiveFacet

org.eclipse.tigerstripe.internal.api.contract.segment.IFacetReference getActiveFacet()
                                                                                     throws TigerstripeException
Throws:
TigerstripeException

getAdvancedProperty

java.lang.String getAdvancedProperty(java.lang.String property)
                                     throws TigerstripeException
Throws:
TigerstripeException

getAdvancedProperty

java.lang.String getAdvancedProperty(java.lang.String property,
                                     java.lang.String defaultValue)
                                     throws TigerstripeException
Throws:
TigerstripeException

getIArtifactManagerSession

org.eclipse.tigerstripe.internal.api.model.IArtifactManagerSession getIArtifactManagerSession()
                                                                                              throws TigerstripeException
Returns the artifact manager session for this Tigerstripe project.

Returns:
Throws:
TigerstripeException

getIPluginReferences

IPluginReference[] getIPluginReferences()
                                        throws TigerstripeException
Returns the Plugin references defined in this project

Returns:
Throws:
TigerstripeException

getIReferencedProjects

ITigerstripeProject[] getIReferencedProjects()
                                             throws TigerstripeException
Throws:
TigerstripeException