|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 |
---|
static final int GENERATE_CATEGORY
static final int PUBLISH_CATEGORY
static final int UNKNOWN_CATEGORY
Method Detail |
---|
void trigger() throws TigerstripeException
TigerstripeException
void trigger(org.eclipse.tigerstripe.internal.core.generation.RunConfig config) throws TigerstripeException
config
- -
optional additional info for plugin run
TigerstripeException
void setEnabled(boolean enabled)
enabled
- void setProjectHandle(ITigerstripeProject projectHandle)
boolean isLogEnabled()
PluginLog.LogLevel getCurrentLogLevel()
java.lang.String getLogPath()
void setLogLevel(PluginLog.LogLevel logLevel)
void setDisableLogging(boolean disable)
disable
- boolean isLoggingDisabled()
void fail(java.lang.String message)
message
- void fail(java.lang.String message, java.lang.Throwable t)
message
- t
- boolean validationFailed()
java.lang.String getValidationFailMessage()
java.lang.Throwable getValidationFailThrowable()
java.lang.String getActiveVersion()
int getCategory()
java.lang.String[] getDefinedProperties()
java.lang.String getGroupId()
java.lang.String getPluginId()
ITigerstripeProject getProjectHandle()
@Deprecated java.util.Properties getProperties()
getProperty(String)
. Note that table properties
cannot be read through this method.
java.lang.Object getProperty(java.lang.String propertyName)
propertyName
-
java.lang.String getVersion()
boolean isEnabled()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |