org.sonarsource.analyzer.commons.collections.MapBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-analyzer-commons Show documentation

Logic useful for a language plugin

There is a newer version: 2.16.0.3141

Show newest version

/*
 * SonarSource Analyzers Commons
 * 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.sonarsource.analyzer.commons.collections;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

/**
 * This class is used for Java < 9 to simplify the creation of maps.
 * After moving to Java > 9, should be replaced by Immutable Map Static Factory Methods
 * @see Immutable Map Static Factory Methods
 */
public final class MapBuilder {

  public static  MapBuilder newMap() {
    return new MapBuilder<>();
  }

  private final Map map;

  private MapBuilder() {
    this.map = new HashMap<>();
  }

  public MapBuilder put(K key, V value) {
    map.put(key, value);
    return this;
  }

  public Map build() {
    return Collections.unmodifiableMap(map);
  }
}