org.opendaylight.protocol.bgp.rib.impl.CountersUtil Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bgp-rib-impl Show documentation

BGP RIB implementation

The newest version!

/*
 * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.protocol.bgp.rib.impl;

import java.util.concurrent.atomic.LongAdder;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.rib.TablesKey;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Provides util for increment/decrement counters whenever is not null
 * Otherwise prints an informative warn.
 */
public final class CountersUtil {
    private static final Logger LOG = LoggerFactory.getLogger(CountersUtil.class);

    private CountersUtil() {
        // Hidden on purpose
    }

    /**
     * Increments counter by 1 if supported, otherwise produce a warn.
     *
     * @param counter   counter
     * @param tablesKey tablesKey Type
     */
    static void increment(final @Nullable LongAdder counter, final @NonNull TablesKey tablesKey) {
        add(counter, tablesKey, 1);
    }

    /**
     * Increments counter by 1 if supported, otherwise produce a warn.
     *
     * @param counter   counter
     * @param tablesKey tablesKey Type
     */
    static void decrement(final @Nullable LongAdder counter, final @NonNull TablesKey tablesKey) {
        add(counter, tablesKey, -1);
    }

    /**
     * Add specified valut to the counter if supported, otherwise produce a warn.
     *
     * @param counter   counter
     * @param tablesKey tablesKey Type
     */
    static void add(final @Nullable LongAdder counter, final @NonNull TablesKey tablesKey, final long amount) {
        if (counter != null) {
            counter.add(amount);
        } else {
            LOG.warn("Family {} not supported", tablesKey);
        }
    }
}