org.apache.camel.management.mbean.Statistic Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-management Show documentation
Camel Management
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.camel.management.mbean;

/**
 * Base implementation of {@link Statistic}
 * 
 * The following modes is available:
 * 
 * VALUE - A statistic with this update mode is a simple value that is a straight forward representation of the
 * updated value.
 * DELTA - A statistic with this update mode is a value that represents the delta between the last two recorded
 * values (or the initial value if two updates have not been recorded). This value can be negative if the delta goes up
 * or down.
 * COUNTER - A statistic with this update mode interprets updates as increments (positive values) or decrements
 * (negative values) to the current value.
 * MAXIMUM - A statistic with this update mode is a value that represents the maximum value amongst the update
 * values applied to this statistic.
 * MINIMUM - A statistic with this update mode is a value that represents the minimum value amongst the update
 * values applied to this statistic.
 * 
 * The MAXIMUM and MINIMUM modes are not 100% thread-safe as there can be a lost-update problem. This is on purpose
 * because the performance overhead to ensure atomic updates costs to much on CPU and memory footprint. The other modes
 * are thread-safe.
 */
public abstract class Statistic {

    public abstract void updateValue(long newValue);

    public void increment() {
        updateValue(1);
    }

    public void decrement() {
        updateValue(-1);
    }

    public abstract long getValue();

    /**
     * Whether the statistic has been updated one or more times. Notice this is only working for value, maximum and
     * minimum modes.
     */
    public abstract boolean isUpdated();

    public abstract void reset();

}