org.apache.struts.config.PlugInConfig Maven / Gradle / Ivy

/*
 * $Id: PlugInConfig.java 471754 2006-11-06 14:55:09Z husted $
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.struts.config;

import java.io.Serializable;

import java.util.HashMap;
import java.util.Map;

/**
 * A JavaBean representing the configuration information of a
 * <plug-in> element in a Struts configuration file.
 * Note that this class does not extend BaseConfig because it
 * is more "internal" than the other classes which do, and because this class
 * has an existing "properties" object which collides with the one in
 * BaseConfig.  Also, since one always writes a concrete PlugIn
 * implementation, there seems to be less call for an arbitrary property map;
 * one can simply use bean properties instead.
 *
 * @version $Rev: 471754 $ $Date: 2005-05-12 18:41:19 -0400 (Thu, 12 May 2005)
 *          $
 * @since Struts 1.1
 */
public class PlugInConfig implements Serializable {
    // ----------------------------------------------------- Instance Variables

    /**
     * Has this component been completely configured?
     */
    protected boolean configured = false;

    /**
     * A Map of the name-value pairs that will be used to
     * configure the property values of a PlugIn instance.
     */
    protected Map properties = new HashMap();

    // ------------------------------------------------------------- Properties

    /**
     * The fully qualified Java class name of the PlugIn
     * implementation class being configured.
     */
    protected String className = null;

    public String getClassName() {
        return (this.className);
    }

    public void setClassName(String className) {
        this.className = className;
    }

    // --------------------------------------------------------- Public Methods

    /**
     * Add a new property name and value to the set that will be used to
     * configure the PlugIn instance.
     *
     * @param name  Property name
     * @param value Property value
     */
    public void addProperty(String name, String value) {
        if (configured) {
            throw new IllegalStateException("Configuration is frozen");
        }

        properties.put(name, value);
    }

    /**
     * Freeze the configuration of this component.
     */
    public void freeze() {
        configured = true;
    }

    /**
     * Return the properties that will be used to configure a
     * PlugIn instance.
     */
    public Map getProperties() {
        return (properties);
    }
}