org.apache.juneau.utils.AMap Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you 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.apache.juneau.utils;
import java.util.*;
/**
* An extension of {@link LinkedHashMap} with a convenience {@link #append(Object,Object)} method.
*
*
* Primarily used for testing purposes for quickly creating populated maps.
*
* // Example:
* Map<String,Integer> m = new AMap<String,Integer>()
* .append("foo" ,1).append("bar" ,2);
*
*
* @param The key type.
* @param The value type.
*/
@SuppressWarnings("serial")
public final class AMap extends LinkedHashMap {
/**
* Creates an empty map.
*
* @return A new empty map.
*/
public static AMap create() {
return new AMap<>();
}
/**
* Creates a map with one entry.
*
* @param key Entry key.
* @param value Entry value.
* @return A new map with one entry.
*/
public static AMap create(K key, V value) {
return new AMap().append(key, value);
}
/**
* Adds an entry to this map.
*
* @param k The key.
* @param v The value.
* @return This object (for method chaining).
*/
public AMap append(K k, V v) {
put(k, v);
return this;
}
}