com.blacklocus.misc.NoNullsMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jres Show documentation

An HTTP client for ElasticSearch without any code dependency on the ElasticSearch library.

There is a newer version: 0.1.9

/**
 * Copyright 2013 BlackLocus
 *
 * 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 com.blacklocus.misc;

import com.google.common.collect.ImmutableMap;

import java.util.HashMap;

/**
 * A map that ignores null keys or values. The key won't be added at all if it is null or its value is null.
 * Only applies to {@link #put(Object, Object)}.
 * 
 * Use {@link #of(Object, Object)}... as a transparent replacement of {@link ImmutableMap#of()} where nulls are
 * possible, because ImmutableMap will not accept null values anyways.
 *
 * @author Jason Dunkelberger (dirkraft)
 */
public class NoNullsMap extends HashMap {

    public static  ImmutableMap of(K k1, V v1) {
        NoNullsMap map = new NoNullsMap(1);
        map.put(k1, v1);
        return ImmutableMap.copyOf(map);

    }

    public static  ImmutableMap of(K k1, V v1, K k2, V v2, K k3, V v3) {
        NoNullsMap map = new NoNullsMap(3);
        map.put(k1, v1);
        map.put(k2, v2);
        map.put(k3, v3);
        return ImmutableMap.copyOf(map);
    }

    public static  ImmutableMap of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4) {
        NoNullsMap map = new NoNullsMap(3);
        map.put(k1, v1);
        map.put(k2, v2);
        map.put(k3, v3);
        map.put(k4, v4);
        return ImmutableMap.copyOf(map);
    }

    private NoNullsMap(int initialCapacity) {
        super(initialCapacity);
    }

    /**
     * Ignores null keys or values. The key won't be added at all if it is null or its value is null.
     */
    @Override
    public V put(K key, V value) {
        return key != null && value != null ? super.put(key, value) : null;
    }
}