org.apache.tapestry5.ioc.internal.ValidatingMappedConfigurationWrapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tapestry-ioc
The newest version!
// 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.apache.tapestry5.ioc.internal;

import org.apache.tapestry5.commons.MappedConfiguration;
import org.apache.tapestry5.commons.ObjectLocator;
import org.apache.tapestry5.ioc.def.ContributionDef;

import java.util.Map;

/**
 * A wrapper around a Map that provides the {@link org.apache.tapestry5.commons.MappedConfiguration} interface, and provides
 * two forms of validation for mapped configurations:
 * 
 * If either key or value is null, then a warning is logged
 * If the key has previously been stored (by some other {@link org.apache.tapestry5.ioc.def.ContributionDef}, then a
 * warning is logged
 * 
 *
 * When a warning is logged, the key/value pair is not added to the delegate.
 *
 * Handles instantiation of instances.
 * 
 * @param  the key type
 * @param  the value type
 */
public class ValidatingMappedConfigurationWrapper extends AbstractConfigurationImpl implements
        MappedConfiguration
{
    private final TypeCoercerProxy typeCoercer;

    private final Map map;

    private final Map> overrides;

    private final String serviceId;

    private final ContributionDef contributionDef;

    private final Class expectedKeyType;

    private final Class expectedValueType;

    private final Map keyToContributor;

    public ValidatingMappedConfigurationWrapper(Class expectedValueType, ObjectLocator locator,
            TypeCoercerProxy typeCoercer, Map map, Map> overrides,
            String serviceId, ContributionDef contributionDef, Class expectedKeyType,
            Map keyToContributor)
    {
        super(expectedValueType, locator);

        this.typeCoercer = typeCoercer;
        this.map = map;
        this.overrides = overrides;
        this.serviceId = serviceId;
        this.contributionDef = contributionDef;
        this.expectedKeyType = expectedKeyType;
        this.expectedValueType = expectedValueType;
        this.keyToContributor = keyToContributor;
    }

    @Override
    public void add(K key, V value)
    {
        validateKey(key);

        if (value == null)
            throw new NullPointerException(IOCMessages.contributionWasNull(serviceId));

        V coerced = typeCoercer.coerce(value, expectedValueType);

        ContributionDef existing = keyToContributor.get(key);

        if (existing != null)
            throw new IllegalArgumentException(IOCMessages.contributionDuplicateKey(serviceId, key, existing));

        map.put(key, coerced);

        // Remember that this key is provided by this contribution, when looking
        // for future conflicts.

        keyToContributor.put(key, contributionDef);
    }

    private void validateKey(K key)
    {
        if (key == null)
            throw new NullPointerException(IOCMessages.contributionKeyWasNull(serviceId));

        // Key types don't get coerced; not worth the effort, keys are almost always String or Class
        // anyway.

        if (!expectedKeyType.isInstance(key))
            throw new IllegalArgumentException(IOCMessages.contributionWrongKeyType(serviceId, key.getClass(),
                    expectedKeyType));
    }

    @Override
    public void addInstance(K key, Class clazz)
    {
        add(key, instantiate(clazz));
    }

    @Override
    public void override(K key, V value)
    {
        validateKey(key);

        V coerced = value == null ? null : typeCoercer.coerce(value, expectedValueType);

        MappedConfigurationOverride existing = overrides.get(key);

        if (existing != null)
            throw new IllegalArgumentException(String.format(
                    "Contribution key %s has already been overridden (by %s).", key, existing.getContribDef()));

        overrides.put(key, new MappedConfigurationOverride(contributionDef, map, key, coerced));
    }

    @Override
    public void overrideInstance(K key, Class clazz)
    {
        override(key, instantiate(clazz));
    }
}