fr.cenotelie.commons.utils.config.Section Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2016 Association Cénotélie (cenotelie.fr)
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
 * Public License along with this program.
 * If not, see .
 ******************************************************************************/

package fr.cenotelie.commons.utils.config;

import fr.cenotelie.commons.utils.IOUtils;
import fr.cenotelie.commons.utils.TextUtils;

import java.io.IOException;
import java.io.Writer;
import java.util.*;

/**
 * Represents a section in a configuration file
 * This structure is NOT thread safe
 *
 * @author Laurent Wouters
 */
public class Section {
    /**
     * The section's name
     */
    private final String name;
    /**
     * The properties in this section
     */
    private final Map> properties;

    /**
     * Initializes this section
     *
     * @param name The section's name
     */
    public Section(String name) {
        this.name = name;
        this.properties = new HashMap<>();
    }

    /**
     * Gets the section's name
     *
     * @return The section's name
     */
    public String getName() {
        return name;
    }

    /**
     * Gets whether this section is empty
     *
     * @return true if this section is empty
     */
    public boolean isEmpty() {
        return properties.isEmpty();
    }

    /**
     * Gets the set of properties defined in this section
     *
     * @return The set of properties defined in this section
     */
    public List getProperties() {
        return new ArrayList<>(properties.keySet());
    }

    /**
     * Gets the values for the specified property
     *
     * @param property A property in this section
     * @return The values for the specified property
     */
    public List getAll(String property) {
        if (!properties.containsKey(property))
            return Collections.emptyList();
        return new ArrayList<>(properties.get(property));
    }

    /**
     * Gets the first value for the specified property
     *
     * @param property A property in this section
     * @return The first value for the specified property, or null if there is none
     */
    public String get(String property) {
        if (!properties.containsKey(property))
            return null;
        List values = properties.get(property);
        if (values.isEmpty())
            return null;
        return values.get(0);
    }

    /**
     * Gets whether the specified property and associated value are present in this section
     *
     * @param property A property
     * @param value    An associated value
     * @return Whether the property has the associated value
     */
    public boolean hasValue(String property, String value) {
        List values = properties.get(property);
        return !(values == null || values.isEmpty()) && values.contains(value);
    }

    /**
     * Adds the specified property - value pair to this section
     *
     * @param property A property
     * @param value    A value to associate to the property
     */
    public void add(String property, String value) {
        List values = properties.get(property);
        if (values == null) {
            values = new ArrayList<>();
            properties.put(property, values);
        }
        values.add(value);
    }

    /**
     * Removes the specified property - value pair from this section
     *
     * @param property A property
     * @param value    The associated value to remove
     */
    public void remove(String property, String value) {
        List values = properties.get(property);
        if (values == null)
            return;
        values.remove(value);
    }

    /**
     * Sets the property, removing all previous values, if any
     *
     * @param property A property
     * @param value    The new value
     */
    public void set(String property, String value) {
        List values = properties.get(property);
        if (values == null) {
            values = new ArrayList<>();
            properties.put(property, values);
        }
        values.clear();
        values.add(value);
    }

    /**
     * Clears any value for the property
     *
     * @param property The property to clear
     */
    public void clear(String property) {
        properties.remove(property);
    }

    /**
     * Exports this section to the specified writer
     *
     * @param writer A writer
     * @throws IOException when writing fails
     */
    public void save(Writer writer) throws IOException {
        List keys = new ArrayList<>(properties.keySet());
        Collections.sort(keys);
        if (name != null) {
            writer.write("[");
            writer.write(name);
            writer.write("]");
            writer.write(IOUtils.LINE_SEPARATOR);
        }
        for (String option : keys) {
            for (String value : properties.get(option)) {
                writer.write(option + " = " + TextUtils.escapeStringBaseDoubleQuote(value) + IOUtils.LINE_SEPARATOR);
            }
        }
    }
}