org.eclipse.tigerstripe.workbench.project
Interface ITigerstripeGeneratorProject

All Superinterfaces:
IAbstractTigerstripeProject, IWorkingCopy
All Known Subinterfaces:
ITigerstripeM0GeneratorProject, ITigerstripeM1GeneratorProject

public interface ITigerstripeGeneratorProject
extends IAbstractTigerstripeProject


Field Summary
static int ADDITIONAL_FILE_EXCLUDE
           
static int ADDITIONAL_FILE_INCLUDE
           
 
Method Summary
 void addAdditionalFile(java.lang.String relativePath, int includeExclude)
           
 void addClasspathEntry(IPluginClasspathEntry entry)
           
 void addGlobalProperties(IPluginProperty[] properties)
           
 void addGlobalProperty(IPluginProperty property)
           
 void addGlobalRule(IRule rule)
           
 void addGlobalRules(IRule[] rules)
           
 void addRequiredAnnotationPlugins(java.lang.String[] pluginIds)
           
 java.lang.String[] getAdditionalFiles(int includeExclude)
           
 IPluginClasspathEntry[] getClasspathEntries()
           
 PluginLog.LogLevel getDefaultLogLevel()
           
 IPluginProperty[] getGlobalProperties()
           
 IRule[] getGlobalRules()
           
 java.lang.String getId()
          Returns a unique ID for the generator ID based on its name, version, group.
 java.lang.String getLogPath()
           
 EPluggablePluginNature getPluginNature()
           
 java.lang.String[] getRequiredAnnotationPlugins()
           
 java.lang.String[] getSupportedGlobalRuleLabels()
           
<T extends IRule>
java.lang.Class<T>[]
getSupportedGlobalRules()
           
<T extends IPluginProperty>
java.lang.Class<T>[]
getSupportedProperties()
           
 boolean isLogEnabled()
           
 IPluginClasspathEntry makeClasspathEntry()
           
<T extends IPluginProperty>
IPluginProperty
makeProperty(java.lang.Class<T> propertyType)
          Factory method for Plugin properties
<T extends IRule>
IRule
makeRule(java.lang.Class<T> ruleType)
          Global rules are run once per generation cycle
 void removeAdditionalFile(java.lang.String relativePath, int includeExclude)
           
 void removeClasspathEntries(IPluginClasspathEntry[] entries)
           
 void removeClasspathEntry(IPluginClasspathEntry entry)
           
 void removeGlobalProperties(IPluginProperty[] properties)
           
 void removeGlobalProperty(IPluginProperty property)
           
 void removeGlobalRule(IRule rule)
           
 void removeGlobalRules(IRule[] rules)
           
 void removeRequiredAnnotationPlugins(java.lang.String[] pluginIds)
           
 void setDefaultLogLevel(PluginLog.LogLevel defaultLevel)
           
 void setGlobalProperties(IPluginProperty[] properties)
           
 void setLogEnabled(boolean isLogEnabled)
           
 void setLogPath(java.lang.String logPath)
           
 void setPluginNature(EPluggablePluginNature nature)
           
 void setRequiredAnnotationPlugins(java.lang.String[] pluginIds)
           
 
Methods inherited from interface org.eclipse.tigerstripe.workbench.project.IAbstractTigerstripeProject
containsErrors, delete, exists, getFullPath, getLocation, getName, getProjectDetails, setProjectDetails
 
Methods inherited from interface org.eclipse.tigerstripe.workbench.IWorkingCopy
addOriginalChangeListener, commit, dispose, getOriginal, isDirty, isWorkingCopy, makeWorkingCopy, removeOriginalChangeListener
 

Field Detail

ADDITIONAL_FILE_INCLUDE

static final int ADDITIONAL_FILE_INCLUDE
See Also:
Constant Field Values

ADDITIONAL_FILE_EXCLUDE

static final int ADDITIONAL_FILE_EXCLUDE
See Also:
Constant Field Values
Method Detail

getGlobalProperties

IPluginProperty[] getGlobalProperties()
                                      throws TigerstripeException
Throws:
TigerstripeException

setGlobalProperties

void setGlobalProperties(IPluginProperty[] properties)
                         throws WorkingCopyException,
                                TigerstripeException
Throws:
WorkingCopyException
TigerstripeException

addGlobalProperty

void addGlobalProperty(IPluginProperty property)
                       throws WorkingCopyException,
                              TigerstripeException
Throws:
WorkingCopyException
TigerstripeException

removeGlobalProperty

void removeGlobalProperty(IPluginProperty property)
                          throws WorkingCopyException,
                                 TigerstripeException
Throws:
WorkingCopyException
TigerstripeException

removeGlobalProperties

void removeGlobalProperties(IPluginProperty[] properties)
                            throws WorkingCopyException,
                                   TigerstripeException
Throws:
WorkingCopyException
TigerstripeException

addGlobalProperties

void addGlobalProperties(IPluginProperty[] properties)
                         throws WorkingCopyException,
                                TigerstripeException
Throws:
WorkingCopyException
TigerstripeException

getSupportedProperties

<T extends IPluginProperty> java.lang.Class<T>[] getSupportedProperties()

getGlobalRules

IRule[] getGlobalRules()
                       throws TigerstripeException
Throws:
TigerstripeException

addGlobalRule

void addGlobalRule(IRule rule)
                   throws TigerstripeException
Throws:
TigerstripeException

removeGlobalRule

void removeGlobalRule(IRule rule)
                      throws TigerstripeException
Throws:
TigerstripeException

removeGlobalRules

void removeGlobalRules(IRule[] rules)
                       throws TigerstripeException
Throws:
TigerstripeException

addGlobalRules

void addGlobalRules(IRule[] rules)
                    throws TigerstripeException
Throws:
TigerstripeException

getSupportedGlobalRules

<T extends IRule> java.lang.Class<T>[] getSupportedGlobalRules()

getSupportedGlobalRuleLabels

java.lang.String[] getSupportedGlobalRuleLabels()

makeRule

<T extends IRule> IRule makeRule(java.lang.Class<T> ruleType)
               throws TigerstripeException
Global rules are run once per generation cycle

Throws:
TigerstripeException

makeProperty

<T extends IPluginProperty> IPluginProperty makeProperty(java.lang.Class<T> propertyType)
                             throws TigerstripeException
Factory method for Plugin properties

Throws:
TigerstripeException

addClasspathEntry

void addClasspathEntry(IPluginClasspathEntry entry)
                       throws TigerstripeException
Throws:
TigerstripeException

removeClasspathEntry

void removeClasspathEntry(IPluginClasspathEntry entry)
                          throws TigerstripeException
Throws:
TigerstripeException

removeClasspathEntries

void removeClasspathEntries(IPluginClasspathEntry[] entries)
                            throws TigerstripeException
Throws:
TigerstripeException

makeClasspathEntry

IPluginClasspathEntry makeClasspathEntry()

getClasspathEntries

IPluginClasspathEntry[] getClasspathEntries()
                                            throws TigerstripeException
Throws:
TigerstripeException

addAdditionalFile

void addAdditionalFile(java.lang.String relativePath,
                       int includeExclude)
                       throws WorkingCopyException,
                              TigerstripeException
Throws:
WorkingCopyException
TigerstripeException

removeAdditionalFile

void removeAdditionalFile(java.lang.String relativePath,
                          int includeExclude)
                          throws WorkingCopyException,
                                 TigerstripeException
Throws:
WorkingCopyException
TigerstripeException

getAdditionalFiles

java.lang.String[] getAdditionalFiles(int includeExclude)
                                      throws TigerstripeException
Throws:
TigerstripeException

setLogEnabled

void setLogEnabled(boolean isLogEnabled)
                   throws TigerstripeException
Throws:
TigerstripeException

isLogEnabled

boolean isLogEnabled()
                     throws TigerstripeException
Throws:
TigerstripeException

setLogPath

void setLogPath(java.lang.String logPath)
                throws TigerstripeException
Throws:
TigerstripeException

getLogPath

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

getDefaultLogLevel

PluginLog.LogLevel getDefaultLogLevel()
                                      throws TigerstripeException
Throws:
TigerstripeException

setDefaultLogLevel

void setDefaultLogLevel(PluginLog.LogLevel defaultLevel)
                        throws TigerstripeException
Throws:
TigerstripeException

getPluginNature

EPluggablePluginNature getPluginNature()
                                       throws TigerstripeException
Throws:
TigerstripeException

setPluginNature

void setPluginNature(EPluggablePluginNature nature)
                     throws WorkingCopyException,
                            TigerstripeException
Throws:
WorkingCopyException
TigerstripeException

getId

java.lang.String getId()
                       throws TigerstripeException
Returns a unique ID for the generator ID based on its name, version, group.

Returns:
Throws:
TigerstripeException

getRequiredAnnotationPlugins

java.lang.String[] getRequiredAnnotationPlugins()
                                                throws TigerstripeException
Throws:
TigerstripeException

setRequiredAnnotationPlugins

void setRequiredAnnotationPlugins(java.lang.String[] pluginIds)
                                  throws TigerstripeException
Throws:
TigerstripeException

addRequiredAnnotationPlugins

void addRequiredAnnotationPlugins(java.lang.String[] pluginIds)
                                  throws TigerstripeException
Throws:
TigerstripeException

removeRequiredAnnotationPlugins

void removeRequiredAnnotationPlugins(java.lang.String[] pluginIds)
                                     throws TigerstripeException
Throws:
TigerstripeException