org.apache.empire.commons.ArrayMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of empire-db Show documentation
The newest version!
/*
 * 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.empire.commons;

import java.util.AbstractMap;
import java.util.Map;
import java.util.Set;

import org.apache.empire.exceptions.InvalidArgumentException;

/**
 * This class is a lightweight Map implementation using an ArrayList
 */
public class ArrayMap extends AbstractMap
{    
    /**
     * The Entry class represents a map entry
     */
    public static class Entry implements Map.Entry
    {
        private final K key;
        private V value;
        
        public Entry(K key, V value)
        {
            this.key = key;
            this.value = value;
        }
        
        @Override
        public K getKey()
        {
            return key;
        }

        @Override
        public V getValue()
        {
            return value;
        }

        @Override
        public V setValue(V value)
        {
            V prev = this.value;
            this.value = value;
            return prev;
        }
        
        @Override
        public int hashCode()
        {
            return (key!=null ? key.hashCode() : 0);
        }
        
        @Override
        public boolean equals(Object obj)
        {
            if (super.equals(obj))
                return true;
            // compare
            if (obj instanceof Entry)
            {   // Key and value must match
                Entry other = ((Entry)obj);
                return ObjectUtils.compareEqual(key, other.getKey())
                    && ObjectUtils.compareEqual(value, other.getValue());
            }
            return false;
        }
        
        @Override
        public String toString()
        {
            String k = (key instanceof Enum) ? ((Enum)key).name() : String.valueOf(key);
            String v = String.valueOf(value);
            StringBuilder b = new StringBuilder(k.length()+v.length()+4);
            b.append("{");
            b.append(k);
            b.append("=");
            b.append(v);
            b.append("}");
            return b.toString();
        }
    }
    
    private ArraySet> entries;
    
    /**
     * Default constructor 
     */
    public ArrayMap()
    {
        this.entries = new ArraySet>();
    }

    /**
     * Constructor with initialCapacity 
     * @param initialCapacity the initial capacity
     */
    public ArrayMap(int initialCapacity)
    {
        this.entries = new ArraySet>(initialCapacity);
    }
    
    /**
     * Copy Constructor
     * @param other the map from which to copy
     */
    public ArrayMap(final Map other)
    {
        this.entries = new ArraySet>(other.size());
        for (Map.Entry e : other.entrySet())
            this.entries.fastAdd(new Entry(e.getKey(), e.getValue()));
    }
    
    /**
     * Builder method to build an ArrayMap
     * @param key the Key
     * @param value the Value
     * @return the ArrayMap
     */
    public ArrayMap add(K key, V value)
    {
        put(key, value);
        return this;
    }
    
    @Override
    public Set> entrySet()
    {
        return entries;
    }

    @Override
    public V remove(Object key) 
    {
        @SuppressWarnings("unchecked")
        int index = getIndex((K)key);
        if (index<0)
            return null; // not found
        // found
        Map.Entry entry = entries.get(index);
        entries.remove(index);
        return entry.getValue();
    }
    
    @Override
    public V put(K key, V value)
    {
        Map.Entry entry = getEntry(key);
        if (entry!=null)
            return entry.setValue(value);
        // not found, so add
        entries.fastAdd(new Entry(key, value));
        return null;
    }
    
    public void put(K key, V value, int index)
    {
        if (index<0)
        {   // add to end
            this.put(key, value);
            return;
        }
        // index
        if (index>entries.size())
            throw new InvalidArgumentException("index", index);
        // exists
        int current = getIndex(key);
        if (current==index)
        {   // correct position
            Map.Entry entry = entries.get(index);
            entry.setValue(value);
            return;
        }
        if (current>=0)
        {   // remove at this position
            entries.remove(current);
            if (current(key, value));
    }
    
    public int getIndex(K key)
    {
        for (int index=0; index entry = entries.get(index);
            if (ObjectUtils.compareEqual(entry.getKey(), key))
                return index;
        }
        return -1;
    }
    
    public Map.Entry getEntry(K key)
    {
        int index = getIndex(key);
        return (index>=0 ? entries.get(index) : null);
    }

    
}