org.gradle.api.internal.provider.DefaultMapProperty Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018 the original author or authors.
 *
 * 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 org.gradle.api.internal.provider;

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import org.gradle.api.provider.MapProperty;
import org.gradle.api.provider.Provider;

import javax.annotation.Nullable;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.Callable;

public class DefaultMapProperty extends AbstractProperty> implements MapProperty, MapProviderInternal {

    private static final MapCollectors.EmptyMap EMPTY_MAP = new MapCollectors.EmptyMap();
    private static final MapCollectors.NoValue NO_VALUE = new MapCollectors.NoValue();

    private static final String NULL_KEY_FORBIDDEN_MESSAGE = String.format("Cannot add an entry with a null key to a property of type %s.", Map.class.getSimpleName());
    private static final String NULL_VALUE_FORBIDDEN_MESSAGE = String.format("Cannot add an entry with a null value to a property of type %s.", Map.class.getSimpleName());

    private final Class keyType;
    private final Class valueType;
    private final ValueCollector keyCollector;
    private final MapEntryCollector entryCollector;
    private MapCollector value;
    private final List> collectors = new LinkedList>();

    public DefaultMapProperty(Class keyType, Class valueType) {
        applyDefaultValue();
        this.keyType = keyType;
        this.valueType = valueType;
        keyCollector = new ValidatingValueCollector(Set.class, keyType, ValueSanitizers.forType(keyType));
        entryCollector = new ValidatingMapEntryCollector(keyType, valueType, ValueSanitizers.forType(keyType), ValueSanitizers.forType(valueType));
    }

    @Nullable
    @Override
    @SuppressWarnings("unchecked")
    public Class> getType() {
        return (Class) Map.class;
    }

    @Override
    public Class getKeyType() {
        return keyType;
    }

    @Override
    public Class getValueType() {
        return valueType;
    }

    @Override
    public boolean isPresent() {
        beforeRead();
        if (!value.present()) {
            return false;
        }
        for (MapCollector collector : collectors) {
            if (!collector.present()) {
                return false;
            }
        }
        return true;
    }

    @Override
    public Map get() {
        beforeRead();
        Map entries = new LinkedHashMap(1 + collectors.size());
        value.collectInto(entryCollector, entries);
        for (MapCollector collector : collectors) {
            collector.collectInto(entryCollector, entries);
        }
        return ImmutableMap.copyOf(entries);
    }

    @Nullable
    @Override
    public Map getOrNull() {
        beforeRead();
        return doGetOrNull();
    }

    @Nullable
    private Map doGetOrNull() {
        Map entries = new LinkedHashMap(1 + collectors.size());
        if (!value.maybeCollectInto(entryCollector, entries)) {
            return null;
        }
        for (MapCollector collector : collectors) {
            if (!collector.maybeCollectInto(entryCollector, entries)) {
                return null;
            }
        }
        return ImmutableMap.copyOf(entries);
    }

    @Override
    public Provider getting(final K key) {
        return new DefaultProvider(new Callable() {
            @Override
            @Nullable
            public V call() {
                Map dest = new LinkedHashMap();
                for (int i = collectors.size() - 1; i >= 0; i--) {
                    if (collectors.get(i).maybeCollectInto(entryCollector, dest)) {
                        V value = dest.get(key);
                        if (value != null) {
                            return value;
                        }
                    } else {
                        return null;
                    }
                    dest.clear();
                }
                if (value.maybeCollectInto(entryCollector, dest)) {
                    V value = dest.get(key);
                    if (value != null) {
                        return value;
                    }
                }
                return null;
            }
        });
    }

    @Override
    @SuppressWarnings("unchecked")
    public MapProperty empty() {
        if (beforeMutate()) {
            set((MapCollector) EMPTY_MAP);
        }
        return this;
    }

    @Override
    @SuppressWarnings("unchecked")
    public void setFromAnyValue(@Nullable Object object) {
        if (object == null || object instanceof Map) {
            set((Map) object);
        } else if (object instanceof Provider) {
            set((Provider) object);
        } else {
            throw new IllegalArgumentException(String.format(
                "Cannot set the value of a property of type %s using an instance of type %s.", Map.class.getName(), object.getClass().getName()));
        }
    }

    @Override
    @SuppressWarnings("unchecked")
    public void set(@Nullable Map entries) {
        if (!beforeMutate()) {
            return;
        }
        if (entries != null) {
            set(new MapCollectors.EntriesFromMap(entries));
        } else {
            set((MapCollector) NO_VALUE);
        }
    }

    @Override
    public void set(Provider> provider) {
        if (!beforeMutate()) {
            return;
        }
        ProviderInternal> p = checkMapProvider(provider);
        set(new MapCollectors.EntriesFromMapProvider(p));
    }

    private void set(MapCollector collector) {
        collectors.clear();
        value = collector;
        afterMutate();
    }

    @Override
    public void put(K key, V value) {
        Preconditions.checkNotNull(key, NULL_KEY_FORBIDDEN_MESSAGE);
        Preconditions.checkNotNull(value, NULL_VALUE_FORBIDDEN_MESSAGE);
        if (!beforeMutate()) {
            return;
        }
        addCollector(new MapCollectors.SingleEntry(key, value));
    }

    @Override
    public void put(K key, Provider providerOfValue) {
        Preconditions.checkNotNull(key, NULL_KEY_FORBIDDEN_MESSAGE);
        Preconditions.checkNotNull(providerOfValue, NULL_VALUE_FORBIDDEN_MESSAGE);
        if (!beforeMutate()) {
            return;
        }
        ProviderInternal p = Providers.internal(providerOfValue);
        if (p.getType() != null && !valueType.isAssignableFrom(p.getType())) {
            throw new IllegalArgumentException(String.format("Cannot add an entry to a property of type %s with values of type %s using a provider of type %s.",
                Map.class.getName(), valueType.getName(), p.getType().getName()));
        }
        addCollector(new MapCollectors.EntryWithValueFromProvider(key, p));
    }

    @Override
    public void putAll(Map entries) {
        if (!beforeMutate()) {
            return;
        }
        addCollector(new MapCollectors.EntriesFromMap(entries));
    }

    @Override
    public void putAll(Provider> provider) {
        if (!beforeMutate()) {
            return;
        }
        ProviderInternal> p = checkMapProvider(provider);
        addCollector(new MapCollectors.EntriesFromMapProvider(p));
    }

    private void addCollector(MapCollector collector) {
        collectors.add(collector);
        afterMutate();
    }

    @SuppressWarnings("unchecked")
    private ProviderInternal> checkMapProvider(@Nullable Provider> provider) {
        if (provider == null) {
            throw new IllegalArgumentException("Cannot set the value of a property using a null provider.");
        }
        ProviderInternal> p = Providers.internal(provider);
        if (p.getType() != null && !Map.class.isAssignableFrom(p.getType())) {
            throw new IllegalArgumentException(String.format("Cannot set the value of a property of type %s using a provider of type %s.",
                Map.class.getName(), p.getType().getName()));
        }
        if (p instanceof MapProviderInternal) {
            Class providerKeyType = ((MapProviderInternal) p).getKeyType();
            Class providerValueType = ((MapProviderInternal) p).getValueType();
            if (!keyType.isAssignableFrom(providerKeyType) || !valueType.isAssignableFrom(providerValueType)) {
                throw new IllegalArgumentException(String.format("Cannot set the value of a property of type %s with key type %s and value type %s " +
                        "using a provider with key type %s and value type %s.", Map.class.getName(), keyType.getName(), valueType.getName(),
                    providerKeyType.getName(), providerValueType.getName()));
            }
        }
        return p;
    }

    @Override
    public MapProperty convention(Map value) {
        if (shouldApplyConvention()) {
            this.value = new MapCollectors.EntriesFromMap(value);
            collectors.clear();
        }
        return this;
    }

    @Override
    public MapProperty convention(Provider> valueProvider) {
        if (shouldApplyConvention()) {
            this.value = new MapCollectors.EntriesFromMapProvider(Providers.internal(valueProvider));
            collectors.clear();
        }
        return this;
    }

    @Override
    public Provider> keySet() {
        return new KeySetProvider();
    }

    @Override
    public String toString() {
        List values = new ArrayList(1 + collectors.size());
        values.add(value.toString());
        for (MapCollector collector : collectors) {
            values.add(collector.toString());
        }
        return String.format("Map(%s->%s, %s)", keyType.getSimpleName().toLowerCase(), valueType.getSimpleName(), values);
    }

    @Override
    protected void applyDefaultValue() {
        value = (MapCollector) EMPTY_MAP;
        collectors.clear();
    }

    @Override
    @SuppressWarnings("unchecked")
    protected void makeFinal() {
        Map entries = doGetOrNull();
        if (entries != null) {
            if (entries.isEmpty()) {
                set((MapCollector) EMPTY_MAP);
            } else {
                set(new MapCollectors.EntriesFromMap(entries));
            }
        } else {
            set((MapCollector) NO_VALUE);
        }
    }

    private class KeySetProvider extends AbstractReadOnlyProvider> {

        @Nullable
        @Override
        @SuppressWarnings("unchecked")
        public Class> getType() {
            return (Class) Set.class;
        }

        @Override
        public Set get() {
            beforeRead();
            Set keys = new LinkedHashSet(1 + collectors.size());
            value.collectKeysInto(keyCollector, keys);
            for (MapCollector collector : collectors) {
                collector.collectKeysInto(keyCollector, keys);
            }
            return ImmutableSet.copyOf(keys);
        }

        @Nullable
        @Override
        public Set getOrNull() {
            beforeRead();
            Set keys = new LinkedHashSet(1 + collectors.size());
            if (!value.maybeCollectKeysInto(keyCollector, keys)) {
                return null;
            }
            for (MapCollector collector : collectors) {
                if (!collector.maybeCollectKeysInto(keyCollector, keys)) {
                    return null;
                }
            }
            return ImmutableSet.copyOf(keys);
        }
    }
}