pluginconfigtype.java

### File Source: pluginconfigtype.java

         1  /*
         2   * Copyright (c) 2003-2005, Simon Brown
         3   * All rights reserved.
         4   *
         5   * Redistribution and use in source and binary forms, with or without
         6   * modification, are permitted provided that the following conditions are met:
         7   *
         8   *   - Redistributions of source code must retain the above copyright
         9   *     notice, this list of conditions and the following disclaimer.
        10   *
        11   *   - Redistributions in binary form must reproduce the above copyright
        12   *     notice, this list of conditions and the following disclaimer in
        13   *     the documentation and/or other materials provided with the
        14   *     distribution.
        15   *
        16   *   - Neither the name of Pebble nor the names of its contributors may
        17   *     be used to endorse or promote products derived from this software
        18   *     without specific prior written permission.
        19   *
        20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
        23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
        24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
        25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
        26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
        27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
        28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
        29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
        30   * POSSIBILITY OF SUCH DAMAGE.
        31   */
        32  package net.sourceforge.pebble.plugins;
        33
             /*
        P/P   *  Method: net.sourceforge.pebble.plugins.PluginConfigType__static_init
              */
        34  import javax.servlet.jsp.JspWriter;
        35  import java.io.IOException;
        36
        37  /**
        38   * Represents a plugin configuration type
        39   *
        40   * @author James Roper
        41   */
        42  public interface PluginConfigType {
        43    public static final String PLUGIN_PROPERTY_NAME_PREFIX = "pluginProperty_";
        44
        45    /**
        46     * Render the configuration item to the given writer.  This should result in some form control element.
        47     * The name of the form control should be "pluginProperty_" followed by the pluginConfig.getKey().
        48     *
        49     * @param writer The writer to render to
        50     * @param pluginConfig The configuration to render
        51     * @param value The value to render
        52     * @throws IOException If an error occured
        53     */
        54    void render(JspWriter writer, PluginConfig pluginConfig, String value) throws IOException;
        55
        56    /**
        57     * Validate the value entered the user
        58     *
        59     * @param pluginConfig The config to validate against
        60     * @param value The value to validate
        61     * @return null if validation passed, or a error message if not
        62     */
        63    String validate(PluginConfig pluginConfig, String value);
        64
        65  }

SofCheck Inspector Build Version : 2.22510

pluginconfigtype.java | 2010-Jun-25 19:40:32
pluginconfigtype.class | 2010-Jul-19 20:23:38