com.basistech.rosette.dm.MapAttribute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of adm-model Show documentation
ADM data model.
There is a newer version: 3.0.6
/*
* Copyright 2018 Basis Technology Corp.
*
* 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.basistech.rosette.dm;

import com.google.common.base.MoreObjects;
import com.google.common.collect.Maps;
import lombok.EqualsAndHashCode;

import java.io.Serializable;
import java.util.Collection;
import java.util.Map;
import java.util.Set;

/**
 * A container for a keyed collection of attributes of a type.
 * Like all other attributes, it stores extended properties.
 * It is immutable and throws for attempts to use methods that would modify it.
 *
 * @param  The type of the keys in the map.
 * @param  The type of the values in the map.
 */
@EqualsAndHashCode(callSuper = true)
public class MapAttribute extends BaseAttribute implements Map, Serializable {
    private static final long serialVersionUID = 250L;

    private final Map items;
    private final Class keyClass;
    private final Class valueClass;

    protected MapAttribute(Class keyClass, Class valueClass, Map items) {
        this.items = items;
        this.keyClass = keyClass;
        this.valueClass = valueClass;
    }

    // no json creator. This has custom serialization/deserialization.
    protected MapAttribute(Class keyClass, Class valueClass, Map items, Map extendedProperties) {
        super(extendedProperties);
        this.items = items;
        this.keyClass = keyClass;
        this.valueClass = valueClass;
    }

    /**
     * Internal use API used in Jackson serialization.
     * @return the map itself.
     */
    public Map getItems() {
        return items;
    }

    // this is only used by the serializer, never let it get processed automatically.

    /**
     * Internal use method for Jackson/Json serialization.
     * @return the class of the keys in this list.
     */
    public Class getKeyClass() {
        return keyClass;
    }

    /**
     * Internal use method for Jackson/Json serialization.
     * @return the class of the values in this list.
     */
    public Class getValueClass() {
        return valueClass;
    }

    @Override
    public int size() {
        return items.size();
    }

    @Override
    public boolean isEmpty() {
        return items.isEmpty();
    }

    @Override
    public boolean containsKey(Object key) {
        return items.containsKey(key);
    }

    @Override
    public boolean containsValue(Object value) {
        return items.containsValue(value);
    }

    @Override
    public V get(Object key) {
        return items.get(key);
    }

    @Override
    public V put(K key, V value) {
        throw readOnly();
    }

    @Override
    public V remove(Object key) {
        throw readOnly();
    }

    @Override
    public void putAll(Map m) {
        throw readOnly();
    }

    @Override
    public void clear() {
        throw readOnly();
    }

    @Override
    public Set keySet() {
        return items.keySet();
    }

    @Override
    public Collection values() {
        return items.values();
    }

    @Override
    public Set> entrySet() {
        return items.entrySet();
    }

    @Override
    protected MoreObjects.ToStringHelper toStringHelper() {
        return MoreObjects.toStringHelper(this)
            .add("items", items)
            .add("keyClass", keyClass)
            .add("valueClass", valueClass);
    }

    private static RuntimeException readOnly() {
        return new UnsupportedOperationException("MapAttribute is read-only");
    }

    public static class Builder extends BaseAttribute.Builder, MapAttribute.Builder> {
        private Class keyClass;
        private Class valueClass;
        private Map items;

        /**
         * Constructs an empty builder.
         *
         * @param keyClass the class for the keys to be stored in the map
         * @param valueClass the class for the values to be stored in the map
         */
        public Builder(Class keyClass, Class valueClass) {
            this.keyClass = keyClass;
            this.valueClass = valueClass;
            items = Maps.newHashMap();
        }

        /**
         * Adds one entry to the map.
         *
         * @param key the key to add
         * @param value the value to add
         * @return this
         */
        public Builder put(K key, V value) {
            items.put(key, value);
            return this;
        }

        /**
         * Specifies the complete map.
         *
         * @param items the entire map
         * @return this
         */
        public Builder setItems(Map items) {
            this.items = items;
            return this;
        }

        /**
         * Constructs an immutable map from the current state of the builder.
         *
         * @return the new map
         */
        public MapAttribute build() {
            return new MapAttribute<>(keyClass, valueClass, items, buildExtendedProperties());
        }

        @Override
        protected Builder getThis() {
            return this;
        }
    }
}