org.eclipse.tigerstripe.project
Interface IPluginReference


public interface IPluginReference

A reference to a plugin as it may appear in a Tigerstripe Project. Within a Tigerstripe project, plugin-specific configuration can be stored through these IPluginReference.

Author:
Eric Dillon

Field Summary
static int GENERATE_CATEGORY
           
static int PUBLISH_CATEGORY
           
static int UNKNOWN_CATEGORY
           
 
Method Summary
 void fail(java.lang.String message)
          If this plugin is a validation plugin, the fail method can be used to interrupt the generation cycle.
 void fail(java.lang.String message, java.lang.Throwable t)
          If this plugin is a validation plugin, the fail method can be used to interrupt the generation cycle.
 java.lang.String getActiveVersion()
           
 int getCategory()
           
 PluginLog.LogLevel getCurrentLogLevel()
           
 java.lang.String[] getDefinedProperties()
          An array of all properties defined for this Plugin Ref.
 java.lang.String getGroupId()
           
 java.lang.String getLogPath()
           
 java.lang.String getPluginId()
           
 ITigerstripeProject getProjectHandle()
           
 java.util.Properties getProperties()
          Deprecated. use getProperty(String). Note that table properties cannot be read through this method.
 java.lang.Object getProperty(java.lang.String propertyName)
          Returns the value of the property as defined in the plugin reference.
 java.lang.String getValidationFailMessage()
           
 java.lang.Throwable getValidationFailThrowable()
           
 java.lang.String getVersion()
           
 boolean isEnabled()
           
 boolean isLogEnabled()
           
 boolean isLoggingDisabled()
           
 void setDisableLogging(boolean disable)
          Override the logging details to completely disable the creation of a log file
 void setEnabled(boolean enabled)
          Enables/disables this plugin.
 void setLogLevel(PluginLog.LogLevel logLevel)
           
 void setProjectHandle(ITigerstripeProject projectHandle)
           
 void trigger()
          Trigger the generation association with this Plugin reference
 void trigger(org.eclipse.tigerstripe.internal.core.generation.RunConfig config)
          Trigger the generation association with this Plugin reference
 boolean validationFailed()
          Returns true if the "fail(...)" method was called
 

Field Detail

GENERATE_CATEGORY

static final int GENERATE_CATEGORY
See Also:
Constant Field Values

PUBLISH_CATEGORY

static final int PUBLISH_CATEGORY
See Also:
Constant Field Values

UNKNOWN_CATEGORY

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

trigger

void trigger()
             throws TigerstripeException
Trigger the generation association with this Plugin reference

Throws:
TigerstripeException

trigger

void trigger(org.eclipse.tigerstripe.internal.core.generation.RunConfig config)
             throws TigerstripeException
Trigger the generation association with this Plugin reference

Parameters:
config - - optional additional info for plugin run
Throws:
TigerstripeException

setEnabled

void setEnabled(boolean enabled)
Enables/disables this plugin.

Parameters:
enabled -

setProjectHandle

void setProjectHandle(ITigerstripeProject projectHandle)

isLogEnabled

boolean isLogEnabled()

getCurrentLogLevel

PluginLog.LogLevel getCurrentLogLevel()

getLogPath

java.lang.String getLogPath()

setLogLevel

void setLogLevel(PluginLog.LogLevel logLevel)

setDisableLogging

void setDisableLogging(boolean disable)
Override the logging details to completely disable the creation of a log file

Parameters:
disable -

isLoggingDisabled

boolean isLoggingDisabled()

fail

void fail(java.lang.String message)
If this plugin is a validation plugin, the fail method can be used to interrupt the generation cycle.

Parameters:
message -
Since:
2.2.4

fail

void fail(java.lang.String message,
          java.lang.Throwable t)
If this plugin is a validation plugin, the fail method can be used to interrupt the generation cycle.

Parameters:
message -
t -
Since:
2.2.4

validationFailed

boolean validationFailed()
Returns true if the "fail(...)" method was called

Returns:

getValidationFailMessage

java.lang.String getValidationFailMessage()

getValidationFailThrowable

java.lang.Throwable getValidationFailThrowable()

getActiveVersion

java.lang.String getActiveVersion()

getCategory

int getCategory()

getDefinedProperties

java.lang.String[] getDefinedProperties()
An array of all properties defined for this Plugin Ref.

Returns:

getGroupId

java.lang.String getGroupId()

getPluginId

java.lang.String getPluginId()

getProjectHandle

ITigerstripeProject getProjectHandle()

getProperties

@Deprecated
java.util.Properties getProperties()
Deprecated. use getProperty(String). Note that table properties cannot be read through this method.

Returns:

getProperty

java.lang.Object getProperty(java.lang.String propertyName)
Returns the value of the property as defined in the plugin reference.

Parameters:
propertyName -
Returns:

getVersion

java.lang.String getVersion()

isEnabled

boolean isEnabled()