com.zepben.evolve.metrics.NetworkContainerMetrics.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of evolve-sdk Show documentation

SDK for interaction with the evolve platform

There is a newer version: 0.24.0rc1

/*
 * Copyright 2024 Zeppelin Bend Pty Ltd
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

package com.zepben.evolve.metrics

/**
 * A map from metric names to their values.
 */
class NetworkContainerMetrics(private val map: MutableMap = mutableMapOf()) : MutableMap by map {

    /**
     * Increment the value of the metric named [key]. If no such metric exists, it is automatically created with an initial value of zero.
     *
     * @param key The metric to increment
     * @return This object, for fluent use
     */
    fun inc(key: String): NetworkContainerMetrics = plus(key, 1.0)

    /**
     * Increase the value of the metric named [key] by [amount]. If no such metric exists, it is automatically created with an initial value of zero.
     *
     * @param key The metric to increase
     * @param amount The amount to increase the metric by. A negative value will decrease the metric.
     * @return This object, for fluent use
     */
    fun plus(key: String, amount: Number): NetworkContainerMetrics = apply { merge(key, amount.toDouble(), Double::plus) }

    /**
     * Set the value of the metric named [key] to [value].
     *
     * @param key The metric to set
     * @param value the value to set the metric to
     */
    operator fun set(key: String, value: Int) {
        this[key] = value.toDouble()
    }

    // Make this work as the map.
    override fun hashCode(): Int = map.hashCode()
    override fun equals(other: Any?): Boolean = map == other
    override fun toString(): String = map.toString()
}