plugincontainer.java

spam source codejasen-0.9jASEN - java Anti Spam ENgine.zip 如标题所示

/*
 * @(#)PluginContainer.java	30/10/2004
 *
 * Copyright (c) 2004, 2005  jASEN.org
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in
 *      the documentation and/or other materials provided with the distribution.
 *
 *   3. The names of the authors may not be used to endorse or promote products
 *      derived from this software without specific prior written permission.
 *
 *   4. Any modification or additions to the software must be contributed back
 *      to the project.
 *
 *   5. Any investigation or reverse engineering of source code or binary to
 *      enable emails to bypass the filters, and hence inflict spam and or viruses
 *      onto users who use or do not use jASEN could subject the perpetrator to
 *      criminal and or civil liability.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JASEN.ORG,
 * OR ANY CONTRIBUTORS TO THIS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
package org.jasen.core;

import java.io.Serializable;

import org.jasen.interfaces.JasenPlugin;
import org.jasen.interfaces.ProbabilityCalculator;

/**
 * <P>
 * 	Holds a plugin and its runtime configuration.
 * </P>
 * @author Jason Polites
 */
public class PluginContainer implements Serializable
{
    private JasenPlugin plugin;
    private String name;
    private ProbabilityCalculator calculator;
    
    private String displayName = null;
    private String description = null;

    /**
     *
     */
    public PluginContainer() {
        super ();
    }

    /**
     * Gets the calculator used for this plugin
     * @return The calculator used by the plugin to calculate results
     */
    public ProbabilityCalculator getCalculator() {
        return calculator;
    }

    /**
     * Sets the calculator used for this plugin
     * @param calculator The calculator used by the plugin to calculate results
     */
    public void setCalculator(ProbabilityCalculator calculator) {
        this.calculator = calculator;
    }

    /**
     * Gets the name of this plugin
     * @return The display name of the plugin as a String
     */
    public String getName() {
        return name;
    }

    /**
     * Sets the name of this plugin
     * @param name The display name of the plugin as a String
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * Gets the contained plugin 
     * @return The actual plugin instance
     */
    public JasenPlugin getPlugin() {
        return plugin;
    }

    /**
     * Gets the contained plugin 
     * @param plugin The actual plugin instance
     */
    public void setPlugin(JasenPlugin plugin) {
        this.plugin = plugin;
    }
    
    /**
     * Gets the summary description of this plugin.  Used for display in GUI systems etc.
     * @return Returns the description.
     */
    public String getDescription() {
        return this.description;
    }
    
    
    /**
     * Sets the summary description of this plugin.  Used for display in GUI systems etc.
     * @param description The description to set.
     */
    public void setDescription(String description) {
        this.description = description;
    }
    
    
    /**
     * Gets the user friendly name of this plugin.  Used for display in GUI systems etc.
     * @return Returns the displayName.
     */
    public String getDisplayName() {
        return this.displayName;
    }
    
    /**
     * Sets the user friendly name of this plugin.  Used for display in GUI systems etc.
     * @param displayName The displayName to set.
     */
    public void setDisplayName(String displayName) {
        this.displayName = displayName;
    }    
}