001/*
002 *  Copyright 2015 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.runtime.config;
017
018import org.apache.avalon.framework.configuration.Configuration;
019
020/**
021 * Information on a configuration parameter.
022 */
023public class ConfigParameterInfo
024{
025    private final String _id;
026    private final String _pluginName;
027    private final Configuration _conf;
028    
029    /**
030     * Create a configuration parameter info.
031     * @param id the parameter id.
032     * @param pluginName the declaring plugin name.
033     * @param conf the configuration.
034     */
035    public ConfigParameterInfo(String id, String pluginName, Configuration conf)
036    {
037        _id = id;
038        _conf = conf;
039        _pluginName = pluginName;
040    }
041    
042    /**
043     * Get the parameter ID.
044     * @return the parameter ID.
045     */
046    public String getId()
047    {
048        return _id;
049    }
050    
051    /**
052     * Get the declaring plugin name.
053     * @return the declaring plugin name.
054     */
055    public String getPluginName()
056    {
057        return _pluginName;
058    }
059    
060    /**
061     * Get the declaring configuration.
062     * @return the declaring configuration.
063     */
064    public Configuration getConfiguration()
065    {
066        return _conf;
067    }
068}