org.metafacture.metamorph.api.Maps Maven / Gradle / Ivy
/*
* Copyright 2016 Christoph Böhme
*
* Licensed under the Apache License, Version 2.0 the "License";
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.metafacture.metamorph.api;
import java.util.Collection;
import java.util.Map;
/**
* Provides access to the maps defined in a Metamorph script.
*
* @author Markus Michael Geipel
*
*/
public interface Maps {
String DEFAULT_MAP_KEY = "__default";
/**
* Gets all map names.
*
* @return the {@link Collection} of all map names
*/
Collection getMapNames();
/**
* Gets a map.
*
* @param mapName the name of the map
* @return the Map
*/
Map getMap(String mapName);
/**
* Gets a value from the map.
*
* @param mapName the name of the map
* @param key the key of the map
* @return the value
*/
String getValue(String mapName, String key);
/**
* Returns a Map with a map name.
*
* @param mapName the name of the map
* @param map the map
* @return the Map
*/
Map putMap(String mapName, Map map);
/**
* Puts a value into a map.
*
* @param mapName the name of the map
* @param key the key
* @param value the value
* @return the value
*/
String putValue(String mapName, String key, String value);
}