001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2017 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle;
021
022import java.util.ArrayList;
023import java.util.HashMap;
024import java.util.List;
025import java.util.Map;
026import java.util.Set;
027
028import com.google.common.collect.ImmutableMap;
029import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
030import com.puppycrawl.tools.checkstyle.api.Configuration;
031
032/**
033 * Default implementation of the Configuration interface.
034 * @author lkuehne
035 */
036public final class DefaultConfiguration implements Configuration {
037    private static final long serialVersionUID = 1157875385356127169L;
038
039    /** The name of this configuration. */
040    private final String name;
041
042    /** The list of child Configurations. */
043    private final List<Configuration> children = new ArrayList<>();
044
045    /** The map from attribute names to attribute values. */
046    private final Map<String, String> attributeMap = new HashMap<>();
047
048    /** The map containing custom messages. */
049    private final Map<String, String> messages = new HashMap<>();
050
051    /**
052     * Instantiates a DefaultConfiguration.
053     * @param name the name for this DefaultConfiguration.
054     */
055    public DefaultConfiguration(String name) {
056        this.name = name;
057    }
058
059    @Override
060    public String[] getAttributeNames() {
061        final Set<String> keySet = attributeMap.keySet();
062        return keySet.toArray(new String[keySet.size()]);
063    }
064
065    @Override
066    public String getAttribute(String attributeName) throws CheckstyleException {
067        if (!attributeMap.containsKey(attributeName)) {
068            throw new CheckstyleException(
069                    "missing key '" + attributeName + "' in " + name);
070        }
071        return attributeMap.get(attributeName);
072    }
073
074    @Override
075    public Configuration[] getChildren() {
076        return children.toArray(
077            new Configuration[children.size()]);
078    }
079
080    @Override
081    public String getName() {
082        return name;
083    }
084
085    /**
086     * Makes a configuration a child of this configuration.
087     * @param configuration the child configuration.
088     */
089    public void addChild(Configuration configuration) {
090        children.add(configuration);
091    }
092
093    /**
094     * Removes a child of this configuration.
095     * @param configuration the child configuration to remove.
096     */
097    public void removeChild(final Configuration configuration) {
098        children.remove(configuration);
099    }
100
101    /**
102     * Adds an attribute to this configuration.
103     * @param attributeName the name of the attribute.
104     * @param value the value of the attribute.
105     */
106    public void addAttribute(String attributeName, String value) {
107        final String current = attributeMap.get(attributeName);
108        if (current == null) {
109            attributeMap.put(attributeName, value);
110        }
111        else {
112            attributeMap.put(attributeName, current + "," + value);
113        }
114    }
115
116    /**
117     * Adds a custom message to this configuration.
118     * @param key the message key
119     * @param value the custom message pattern
120     */
121    public void addMessage(String key, String value) {
122        messages.put(key, value);
123    }
124
125    /**
126     * Returns an unmodifiable map instance containing the custom messages
127     * for this configuration.
128     * @return unmodifiable map containing custom messages
129     */
130    @Override
131    public ImmutableMap<String, String> getMessages() {
132        return ImmutableMap.copyOf(messages);
133    }
134}