com.netflix.ndbench.core.config.CompositeConfigSource.java Source code

Introduction

Here is the source code for com.netflix.ndbench.core.config.CompositeConfigSource.java

Source

/*
 *  Copyright 2016 Netflix, Inc.
 *
 *  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.netflix.ndbench.core.config;

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;

import java.util.Collection;

/**
 * A {@link IConfigSource} that delegates method calls to the underline sources.  The order in which values are provided
 * depend on the {@link IConfigSource}s provided.  If user asks for key 'foo', and this composite has three sources, it
 * will first check if the key is found in the first source, if not it will check the second and if not, the third, else
 * return null or false if {@link #contains(String)} was called.
 * <p/>
 * Implementation note: get methods with a default are implemented in {@link AbstractConfigSource}, if the underlying
 * source overrides one of these methods, then that implementation will be ignored.
 */
public class CompositeConfigSource extends AbstractConfigSource {

    private final ImmutableCollection<? extends IConfigSource> sources;

    public CompositeConfigSource(final ImmutableCollection<? extends IConfigSource> sources) {
        Preconditions.checkArgument(!sources.isEmpty(),
                "Can not create a composite config source without config sources!");
        this.sources = sources;
    }

    public CompositeConfigSource(final Collection<? extends IConfigSource> sources) {
        this(ImmutableList.copyOf(sources));
    }

    public CompositeConfigSource(final Iterable<? extends IConfigSource> sources) {
        this(ImmutableList.copyOf(sources));
    }

    public CompositeConfigSource(final IConfigSource... sources) {
        this(ImmutableList.copyOf(sources));
    }

    @Override
    public void initialize() {
        for (final IConfigSource source : sources) {
            //TODO should this catch any potential exceptions?
            source.initialize();
        }
    }

    @Override
    public int size() {
        int size = 0;
        for (final IConfigSource c : sources) {
            size += c.size();
        }
        return size;
    }

    @Override
    public boolean isEmpty() {
        return size() == 0;
    }

    @Override
    public boolean contains(final String key) {
        return get(key) != null;
    }

    @Override
    public String get(final String key) {
        Preconditions.checkNotNull(key);
        for (final IConfigSource c : sources) {
            final String value = c.get(key);
            if (value != null) {
                return value;
            }
        }
        return null;
    }

    @Override
    public void set(final String key, final String value) {
        Preconditions.checkNotNull(value, "Value can not be null for configurations.");
        final IConfigSource firstSource = Iterables.getFirst(sources, null);
        // firstSource shouldn't be null because the collection is immutable, and the collection is non empty.
        Preconditions.checkState(firstSource != null, "There was no IConfigSource found at the first location?");
        firstSource.set(key, value);
    }
}