com.rabbitmq.perf.ValueIndicator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of perf-test Show documentation

A Java-based performance testing tool for RabbitMQ.

There is a newer version: 2.22.1

// Copyright (c) 2019 Pivotal Software, Inc.  All rights reserved.
//
// This software, the RabbitMQ Java client library, is triple-licensed under the
// Mozilla Public License 1.1 ("MPL"), the GNU General Public License version 2
// ("GPL") and the Apache License version 2 ("ASL"). For the MPL, please see
// LICENSE-MPL-RabbitMQ. For the GPL, please see LICENSE-GPL2.  For the ASL,
// please see LICENSE-APACHE2.
//
// This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND,
// either express or implied. See the LICENSE file for specific language governing
// rights and limitations of this software.
//
// If you have any questions regarding licensing, please contact us at
// [email protected].

package com.rabbitmq.perf;

import java.util.List;

/**
 * Contract to give hints about the value of a variable.
 * 
 * Can be used to roll over a given set of values for messages rate
 * or size.
 *
 * @since 2.8.0
 */
interface ValueIndicator {

    /**
     * Returns the current value of the variable.
     *
     * @return
     */
    T getValue();

    /**
     * Start method for internal initialization before requesting the value of the variable.
     */
    void start();

    /**
     * Indicates whether the value is supposed to change or not.
     *
     * @return
     */
    boolean isVariable();

    /**
     * Returns all the possible values for the variable.
     *
     * @return
     */
    List values();

}