org.sonar.api.config.internal.MapSettings Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-plugin-api-impl Show documentation

Open source platform for continuous inspection of code quality

There is a newer version: 24.12.0.100206

Show newest version

/*
 * SonarQube
 * Copyright (C) 2009-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * 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, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.api.config.internal;

import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import org.sonar.api.config.Configuration;
import org.sonar.api.config.PropertyDefinitions;
import org.sonar.api.utils.System2;

import static java.util.Collections.unmodifiableMap;
import static java.util.Objects.requireNonNull;

/**
 * In-memory map-based implementation of {@link Settings}. It must be used
 * only for unit tests. This is not the implementation
 * deployed at runtime, so non-test code must never cast
 * {@link Settings} to {@link MapSettings}.
 *
 * @since 6.1
 */
public class MapSettings extends Settings {

  private final Map props = new HashMap<>();
  private final ConfigurationBridge configurationBridge;

  public MapSettings() {
    this(new PropertyDefinitions(System2.INSTANCE));
  }

  public MapSettings(PropertyDefinitions definitions) {
    super(definitions, new Encryption(null));
    configurationBridge = new ConfigurationBridge(this);
  }

  @Override
  protected Optional get(String key) {
    return Optional.ofNullable(props.get(key));
  }

  @Override
  protected void set(String key, String value) {
    props.put(
      requireNonNull(key, "key can't be null"),
      requireNonNull(value, "value can't be null").trim());
  }

  @Override
  protected void remove(String key) {
    props.remove(key);
  }

  @Override
  public Map getProperties() {
    return unmodifiableMap(props);
  }

  /**
   * Delete all properties
   */
  public MapSettings clear() {
    props.clear();
    return this;
  }

  @Override
  public MapSettings setProperty(String key, String value) {
    return (MapSettings) super.setProperty(key, value);
  }

  @Override
  public MapSettings setProperty(String key, Integer value) {
    return (MapSettings) super.setProperty(key, value);
  }

  @Override
  public MapSettings setProperty(String key, Boolean value) {
    return (MapSettings) super.setProperty(key, value);
  }

  @Override
  public MapSettings setProperty(String key, Long value) {
    return (MapSettings) super.setProperty(key, value);
  }

  /**
   * @return a {@link Configuration} proxy on top of this existing {@link Settings} implementation. Changes are reflected in the {@link Configuration} object.
   * @since 6.5
   */
  public Configuration asConfig() {
    return configurationBridge;
  }
}