Environment.java

/* ========================================================================
 * PlantUML : a free UML diagram generator
 * ========================================================================
 *
 * (C) Copyright 2009-2024, Arnaud Roques
 *
 * Project Info:  https://plantuml.com
 * 
 * If you like this project or if you find it useful, you can support us at:
 * 
 * https://plantuml.com/patreon (only 1$ per month!)
 * https://plantuml.com/paypal
 * 
 * This file is part of PlantUML.
 *
 * PlantUML is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * PlantUML 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 General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
 * USA.
 *
 *
 * Original Author:  Arnaud Roques
 * 
 *
 */
package net.sourceforge.plantuml.preproc;

import java.util.LinkedHashMap;
import java.util.Map;

/**
 * What the preprocessor knows about where the diagram comes from: the version,
 * the name and the directory of the file, its date... The preprocessor functions
 * that give those values (%filename(), %dirpath()...) read them here, through the
 * context, at the time they are called, so that they do not depend on a
 * particular diagram and can be shared.
 */
public class Environment {

	private final Map<String, String> values = new LinkedHashMap<String, String>();

	public void put(String key, String value) {
		values.put(key, value);
	}

	/**
	 * Returns the value, or <code>null</code> if there is none.
	 */
	public String get(String key) {
		return values.get(key);
	}

	public void putAll(Environment other) {
		values.putAll(other.values);
	}

	public Environment copy() {
		final Environment result = new Environment();
		result.putAll(this);
		return result;
	}

	@Override
	public String toString() {
		return values.keySet().toString();
	}
}