org.efaps.maven_efaps_jetty.configuration.AbstractDefinition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-efaps-jetty Show documentation
Maven plugin to start Jetty as application server for eFaps.
There is a newer version: 1.19.0-7.5.4.v20111024
/*
 * Copyright 2003 - 2009 The eFaps Team
 *
 * Licensed 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.
 *
 * Revision:        $Rev: 3255 $
 * Last Changed:    $Date: 2009-11-02 18:27:58 -0500 (Mon, 02 Nov 2009) $
 * Last Changed By: $Author: tim.moxter $
 */
package org.efaps.maven_efaps_jetty.configuration;

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

/**
 * @author The eFaps Team
 * @version $Id: AbstractDefinition.java 3255 2009-11-02 23:27:58Z tim.moxter $
 * @todo description
 */
abstract class AbstractDefinition
{
    /**
     * Path specification.
     */
    private String pathSpec = null;

    /**
     * Name.
     */
    private String name = null;

    /**
     * Class name.
     */
    private String className = null;

    /**
     * Map with all init parameters.
     *
     * @see #addIniParam
     */
    private final Map iniParams = new HashMap();

    /**
     * Setter method for instance variable {@link #pathSpec}.
     *
     * @param _pathSpec   path specification
     * @see #pathSpec
     */
    public void setPathSpec(final String _pathSpec)
    {
        this.pathSpec = _pathSpec;
    }

    /**
     * Getter method for instance variable {@link #pathSpec}.
     *
     * @return value of instance variable pathSpec
     * @see #pathSpec
     */
    protected String getPathSpec()
    {
        return this.pathSpec;
    }

    /**
     * Setter method for instance variable {@link #className}.
     *
     * @param _className  name of the class used from the filter
     * @see #className
     */
    public void setClassName(final String _className)
    {
        this.className = _className;
    }

    /**
     * Getter method for instance variable {@link #className}.
     *
     * @return value of instance variable className
     * @see #className
     */
    protected String getClassName()
    {
        return this.className;
    }

    /**
     * Setter method for instance variable {@link #name}.
     *
     * @param _name  new value for instance variable name
     * @see #name
     */
    public void setName(final String _name)
    {
        this.name = _name;
    }

    /**
     * Getter method for instance variable name.
     *
     * @return value of instance variable name
     * @see #name
     */
    protected String getName()
    {
        return this.name;
    }

    /**
     * Adds a new pair of init parameter (key / value).
     *
     * @param _key      key of the init parameter
     * @param _value    value of the init parameter
     * @see #iniParams
     */
    public void addIniParam(final String _key,
                            final String _value)
    {
        this.iniParams.put(_key, _value);
    }

    /**
     * Getter method for instance variable {@link #iniParams}.
     *
     * @return value of instance variable iniParams
     * @see #iniParams
     */
    protected Map getIniParams()
    {
        return this.iniParams;
    }
}