spoon.support.util.ImmutableMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spoon-core Show documentation

Spoon is a tool for meta-programming, analysis and transformation of Java programs.

There is a newer version: 11.1.1-beta-14

/*
 * SPDX-License-Identifier: (MIT OR CECILL-C)
 *
 * Copyright (C) 2006-2023 INRIA and contributors
 *
 * Spoon is available either under the terms of the MIT License (see LICENSE-MIT.txt) or the Cecill-C License (see LICENSE-CECILL-C.txt). You as the user are entitled to choose the terms under which to adopt Spoon.
 */
package spoon.support.util;

import java.util.Map;

/**
 *
 * An immutable map.
 * (eg unmodifiable storage of parameter name-value pairs).
 * The values may be primitive values or List, Set, Map of values.
 * All internal containers are unmodifiable too.
 *
 * Internal class only, not in the public API.
 */
public interface ImmutableMap {

	/**
	 * @param parameterName to be checked parameter name
	 * @return true if there is defined some value for the parameter. null can be a value too
	 */
	boolean hasValue(String parameterName);

	/**
	 * @param parameterName the name of the parameter
	 * @return a value of the parameter under the name `parameterNamer
	 */
	Object getValue(String parameterName);

	/**
	 * @param parameterName to be set parameter name
	 * @param value the new value
	 * @return copies this {@link ImmutableMap}, sets the new value there and returns that copy
	 */
	ImmutableMap putValue(String parameterName, Object value);

	/**
	 * @return underlying unmodifiable Map<String, Object>
	 */
	Map asMap();

	/**
	 * @return a new instance of {@link ImmutableMap}, which inherits all values from this {@link ImmutableMap}
	 * Any call of {@link #putValue(String, Object)} is remembered in local Map of parameters.
	 * At the end of process the {@link #getModifiedValues()} can be used to return all the parameters which were changed
	 * after local {@link ImmutableMap} was created
	 */
	ImmutableMap checkpoint();

	/**
	 * @return the modified parameters since last call to {@link #checkpoint()}
	 */
	Map getModifiedValues();
}