java.com.ionic.sdk.agent.key.KeyAttributesMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ionic-sdk Show documentation
The Ionic Java SDK provides an easy-to-use interface to the Ionic Platform.
There is a newer version: 2.9.0
package com.ionic.sdk.agent.key;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.TreeMap;

/**
 * Contains map of attributes used when a key was created.
 */
public final class KeyAttributesMap extends TreeMap> {

    /**
     * Constructs an empty KeyAttributesMap.
     */
    public KeyAttributesMap() {
        super();
    }

    /**
     * Constructs a new HashMap with the same mappings as the specified map.
     *
     * @param keyMap
     *      The specified map to initialize with.
     */
    public KeyAttributesMap(final KeyAttributesMap keyMap) {
        super();
        if (keyMap != null) {
            for (final Entry> entry : keyMap.entrySet()) {
                put(entry.getKey(), new ArrayList(entry.getValue()));
            }
        }
    }

    /**
     * Constructs a new HashMap from a set of 1..n {@link KeyAttribute}.
     *
     * @param keyAttributes the map values used to initialize this map
     */
    public KeyAttributesMap(final KeyAttribute... keyAttributes) {
        super();
        for (KeyAttribute keyAttribute : keyAttributes) {
            put(keyAttribute.getKey(), keyAttribute);
        }
    }

    /**
     * Check if the map is empty or not.
     *
     * @deprecated Please use {@link Map#isEmpty isEmpty}.
     *
     * @return true if it contains no key-value mappings.
     */
    @Deprecated
    public boolean empty() {
        return this.isEmpty();
    }

    /**
     * Returns the value to which the specified key is mapped,
     * or {@code null} if this map contains no mapping for the key.
     *
     * @param key
     *          attribute key
     * @return attribute value
     */
    public List get(final String key) {
        return ((key == null) ? null : super.get(key));
    }

    /**
     * Associates the specified value with the specified key in this map.
     * If the map previously contained a mapping for the key, the old value is replaced.
     *
     * @deprecated
     *      please use {@link Map#put put} instead.
     *
     * @param key
     *          attribute key
     * @param value
     *          attribute value, which cannot be null
     * @throws NullPointerException
     *          when either the key or the value is null.
     */
    @Deprecated
    public void set(final String key, final Collection value)
        throws NullPointerException {
        if (key == null) {
            throw new NullPointerException("key cannot be null");
        }
        if (value == null) {
            throw new NullPointerException("value cannot be null");
        }

        // ignore return of HashMap.put()
        this.put(key, new ArrayList(value));
    }

    /**
     * Removes the mapping for the specified key from this map if present.
     *
     * @deprecated
     *      please use {@link Map#remove remove} instead.
     *
     * @param key
     *          attribute key
     * @throws NullPointerException
     *           when the specified key is null
     * @throws IndexOutOfBoundsException
     *           when the specified key does not exist
     */
    @Deprecated
    public void delete(final String key)
        throws NullPointerException, IndexOutOfBoundsException {
        if (key == null) {
            throw new NullPointerException("key cannot be null");
        }
        if (this.remove(key) == null) {
            throw new IndexOutOfBoundsException("no mapping for key");
        }
    }

    /**
     * Checks if map contains given key.
     *
     * @deprecated
     *      please use {@link Map#containsKey containsKey} instead.
     *
     * @param key
     *          attribute key
     * @return true if map contains key, false otherwise
     */
    @Deprecated
    public boolean hasKey(final String key) {
        return ((key != null) && this.containsKey(key));
    }

    /**
     * Returns an iterator to enable iterating over the elements of this map.
     *
     * @deprecated
     *      please use {@link Map#entrySet entrySet} and iterate over that set.
     *
     * @return Iterator object
     */
    @Deprecated
    public Iterator>> iterator() {
        return this.entrySet().iterator();
    }

    /** Value of serialVersionUID from maven coordinates "com.ionic:ionic-sdk:2.7.0". */
    private static final long serialVersionUID = -5472314398072920143L;
}