|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| This report was generated with an evaluation server license. Purchase Clover or configure your license. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PluginConfigType | Line # 11 | 0 | - | 0 | 0 | - |
-1.0
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| No Tests | |||
| 1 | package net.sourceforge.pebble.plugins; | |
| 2 | ||
| 3 | import javax.servlet.jsp.JspWriter; | |
| 4 | import java.io.IOException; | |
| 5 | ||
| 6 | /** | |
| 7 | * Represents a plugin configuration type | |
| 8 | * | |
| 9 | * @author James Roper | |
| 10 | */ | |
| 11 | public interface PluginConfigType { | |
| 12 | public static final String PLUGIN_PROPERTY_NAME_PREFIX = "pluginProperty_"; | |
| 13 | ||
| 14 | /** | |
| 15 | * Render the configuration item to the given writer. This should result in some form control element. | |
| 16 | * The name of the form control should be "pluginProperty_" followed by the pluginConfig.getKey(). | |
| 17 | * | |
| 18 | * @param writer The writer to render to | |
| 19 | * @param pluginConfig The configuration to render | |
| 20 | * @param value The value to render | |
| 21 | * @throws IOException If an error occured | |
| 22 | */ | |
| 23 | void render(JspWriter writer, PluginConfig pluginConfig, String value) throws IOException; | |
| 24 | ||
| 25 | /** | |
| 26 | * Validate the value entered the user | |
| 27 | * | |
| 28 | * @param pluginConfig The config to validate against | |
| 29 | * @param value The value to validate | |
| 30 | * @return null if validation passed, or a error message if not | |
| 31 | */ | |
| 32 | String validate(PluginConfig pluginConfig, String value); | |
| 33 | ||
| 34 | } | |
|
||||||||||||