com.arpnetworking.configuration.BaseConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of metrics-cluster-aggregator Show documentation
(Re)Aggregates host level statistics across clusters and writes both host and cluster statistics to various destinations.
There is a newer version: 1.13.7
Show newest version
/*
 * Copyright 2014 Groupon.com
 *
 * 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.arpnetworking.configuration;

import com.arpnetworking.logback.annotations.LogValue;
import com.arpnetworking.steno.LogReferenceOnly;

import java.lang.reflect.Type;
import java.util.NoSuchElementException;
import java.util.Optional;

/**
 * Abstract base class for Configuration implementations which
 * implements the shared convenience methods which rely core methods. The
 * core methods are left for implementation by each concrete subclass.
 *
 * @author Ville Koskela (ville dot koskela at inscopemetrics dot com)
 */
public abstract class BaseConfiguration implements Configuration {

    @Override
    public String getProperty(final String name, final String defaultValue) {
        final Optional optional = getProperty(name);
        if (optional.isPresent()) {
            return optional.get();
        }
        return defaultValue;
    }

    @Override
    public String getRequiredProperty(final String name) throws NoSuchElementException {
        final Optional optional = getProperty(name);
        if (optional.isPresent()) {
            return optional.get();
        }
        throw new NoSuchElementException(
                String.format("Required configuration property does not exist; name=%s", name));
    }

    @Override
    public Optional getPropertyAsBoolean(final String name) {
        final Optional property = getProperty(name);
        return property.isPresent() ? Optional.of(Boolean.parseBoolean(property.get())) : Optional.empty();
    }

    @Override
    public boolean getPropertyAsBoolean(final String name, final boolean defaultValue) {
        final Optional property = getPropertyAsBoolean(name);
        return property.orElse(defaultValue);
    }

    @Override
    public boolean getRequiredPropertyAsBoolean(final String name) throws NoSuchElementException {
        final String property = getRequiredProperty(name);
        return Boolean.parseBoolean(property);
    }

    @Override
    public Optional getPropertyAsInteger(final String name) throws NumberFormatException {
        final Optional property = getProperty(name);
        return property.isPresent() ? Optional.of(Integer.parseInt(property.get())) : Optional.empty();
    }

    @Override
    public int getPropertyAsInteger(final String name, final int defaultValue) throws NumberFormatException {
        final Optional property = getPropertyAsInteger(name);
        return property.orElse(defaultValue);
    }

    @Override
    public int getRequiredPropertyAsInteger(final String name) throws NoSuchElementException, NumberFormatException {
        final String property = getRequiredProperty(name);
        return Integer.parseInt(property);
    }

    @Override
    public Optional getPropertyAsLong(final String name) throws NumberFormatException {
        final Optional property = getProperty(name);
        return property.isPresent() ? Optional.of(Long.parseLong(property.get())) : Optional.empty();
    }

    @Override
    public long getPropertyAsLong(final String name, final long defaultValue) throws NumberFormatException {
        final Optional property = getPropertyAsLong(name);
        return property.orElse(defaultValue);
    }

    @Override
    public long getRequiredPropertyAsLong(final String name) throws NoSuchElementException, NumberFormatException {
        final String property = getRequiredProperty(name);
        return Long.parseLong(property);
    }

    @Override
    public Optional getPropertyAsDouble(final String name) throws NumberFormatException {
        final Optional property = getProperty(name);
        return property.isPresent() ? Optional.of(Double.parseDouble(property.get())) : Optional.empty();
    }

    @Override
    public double getPropertyAsDouble(final String name, final double defaultValue) throws NumberFormatException {
        final Optional property = getPropertyAsDouble(name);
        return property.orElse(defaultValue);
    }

    @Override
    public double getRequiredPropertyAsDouble(final String name) throws NoSuchElementException, NumberFormatException {
        final String property = getRequiredProperty(name);
        return Double.parseDouble(property);
    }

    @Override
    public Optional getPropertyAsFloat(final String name) throws NumberFormatException {
        final Optional property = getProperty(name);
        return property.isPresent() ? Optional.of(Float.parseFloat(property.get())) : Optional.empty();
    }

    @Override
    public float getPropertyAsFloat(final String name, final float defaultValue) throws NumberFormatException {
        final Optional property = getPropertyAsFloat(name);
        return property.orElse(defaultValue);
    }

    @Override
    public float getRequiredPropertyAsFloat(final String name) throws NoSuchElementException, NumberFormatException {
        final String property = getRequiredProperty(name);
        return Float.parseFloat(property);
    }

    @Override
    public Optional getPropertyAsShort(final String name) throws NumberFormatException {
        final Optional property = getProperty(name);
        return property.isPresent() ? Optional.of(Short.valueOf(property.get())) : Optional.empty();
    }

    @Override
    public short getPropertyAsShort(final String name, final short defaultValue) throws NumberFormatException {
        final Optional property = getPropertyAsShort(name);
        return property.isPresent() ? property.get().shortValue() : defaultValue;
    }

    @Override
    public short getRequiredPropertyAsShort(final String name) throws NoSuchElementException, NumberFormatException {
        final String property = getRequiredProperty(name);
        return Short.parseShort(property);
    }

    @Override
    public  T getPropertyAs(final String name, final Class clazz, final T defaultValue)
            throws IllegalArgumentException {
        final Optional property = getPropertyAs(name, clazz);
        return property.isPresent() ? property.get() : defaultValue;
    }

    @Override
    public  T getRequiredPropertyAs(final String name, final Class clazz)
            throws NoSuchElementException, IllegalArgumentException {
        final Optional property = getPropertyAs(name, clazz);
        if (!property.isPresent()) {
            throw new NoSuchElementException(
                    String.format("Required configuration property does not exist; name=%s", name));
        }
        return property.get();
    }

    @Override
    public  T getAs(final Class clazz, final T defaultValue) throws IllegalArgumentException {
        final Optional property = getAs(clazz);
        return property.isPresent() ? property.get() : defaultValue;
    }

    @Override
    public  T getRequiredAs(final Class clazz) throws NoSuchElementException, IllegalArgumentException {
        final Optional property = getAs(clazz);
        if (!property.isPresent()) {
            throw new NoSuchElementException("Configuration does not exist");
        }
        return property.get();
    }

    @Override
    public  T getPropertyAs(final String name, final Type type, final T defaultValue)
            throws IllegalArgumentException {
        final Optional property = getPropertyAs(name, type);
        return property.isPresent() ? property.get() : defaultValue;
    }

    @Override
    public  T getRequiredPropertyAs(final String name, final Type type)
            throws NoSuchElementException, IllegalArgumentException {
        final Optional property = getPropertyAs(name, type);
        if (!property.isPresent()) {
            throw new NoSuchElementException(
                    String.format("Required configuration property does not exist; name=%s", name));
        }
        return property.get();
    }

    @Override
    public  T getAs(final Type type, final T defaultValue) throws IllegalArgumentException {
        final Optional property = getAs(type);
        return property.isPresent() ? property.get() : defaultValue;
    }

    @Override
    public  T getRequiredAs(final Type type) throws NoSuchElementException, IllegalArgumentException {
        final Optional property = getAs(type);
        if (!property.isPresent()) {
            throw new NoSuchElementException("Configuration does not exist");
        }
        return property.get();
    }

    /**
     * Generate a Steno log compatible representation.
     *
     * @return Steno log compatible representation.
     */
    @LogValue
    public Object toLogValue() {
        return LogReferenceOnly.of(this);
    }

    @Override
    public String toString() {
        return toLogValue().toString();
    }
}