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 * @noinspection SerializableHasSerializationMethods
036 */
037public final class DefaultConfiguration implements Configuration {
038    private static final long serialVersionUID = 1157875385356127169L;
039
040    /** The name of this configuration. */
041    private final String name;
042
043    /** The list of child Configurations. */
044    private final List<Configuration> children = new ArrayList<>();
045
046    /** The map from attribute names to attribute values. */
047    private final Map<String, String> attributeMap = new HashMap<>();
048
049    /** The map containing custom messages. */
050    private final Map<String, String> messages = new HashMap<>();
051
052    /** The thread mode configuration. */
053    private final ThreadModeSettings threadModeSettings;
054
055    /**
056     * Instantiates a DefaultConfiguration.
057     * @param name the name for this DefaultConfiguration.
058     */
059    public DefaultConfiguration(String name) {
060        this(name, ThreadModeSettings.SINGLE_THREAD_MODE_INSTANCE);
061    }
062
063    /**
064     * Instantiates a DefaultConfiguration.
065     * @param name the name for this DefaultConfiguration.
066     * @param threadModeSettings the thread mode configuration.
067     */
068    public DefaultConfiguration(String name,
069        ThreadModeSettings threadModeSettings) {
070        this.name = name;
071        this.threadModeSettings = threadModeSettings;
072    }
073
074    @Override
075    public String[] getAttributeNames() {
076        final Set<String> keySet = attributeMap.keySet();
077        return keySet.toArray(new String[keySet.size()]);
078    }
079
080    @Override
081    public String getAttribute(String attributeName) throws CheckstyleException {
082        if (!attributeMap.containsKey(attributeName)) {
083            throw new CheckstyleException(
084                    "missing key '" + attributeName + "' in " + name);
085        }
086        return attributeMap.get(attributeName);
087    }
088
089    @Override
090    public Configuration[] getChildren() {
091        return children.toArray(
092            new Configuration[children.size()]);
093    }
094
095    @Override
096    public String getName() {
097        return name;
098    }
099
100    /**
101     * Makes a configuration a child of this configuration.
102     * @param configuration the child configuration.
103     */
104    public void addChild(Configuration configuration) {
105        children.add(configuration);
106    }
107
108    /**
109     * Removes a child of this configuration.
110     * @param configuration the child configuration to remove.
111     */
112    public void removeChild(final Configuration configuration) {
113        children.remove(configuration);
114    }
115
116    /**
117     * Adds an attribute to this configuration.
118     * @param attributeName the name of the attribute.
119     * @param value the value of the attribute.
120     */
121    public void addAttribute(String attributeName, String value) {
122        final String current = attributeMap.get(attributeName);
123        if (current == null) {
124            attributeMap.put(attributeName, value);
125        }
126        else {
127            attributeMap.put(attributeName, current + "," + value);
128        }
129    }
130
131    /**
132     * Adds a custom message to this configuration.
133     * @param key the message key
134     * @param value the custom message pattern
135     */
136    public void addMessage(String key, String value) {
137        messages.put(key, value);
138    }
139
140    /**
141     * Returns an unmodifiable map instance containing the custom messages
142     * for this configuration.
143     * @return unmodifiable map containing custom messages
144     */
145    @Override
146    public ImmutableMap<String, String> getMessages() {
147        return ImmutableMap.copyOf(messages);
148    }
149
150    /**
151     * Gets the thread mode configuration.
152     * @return the thread mode configuration.
153     */
154    public ThreadModeSettings getThreadModeSettings() {
155        return threadModeSettings;
156    }
157}