cdc.perfs.core.MeasureStatus Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cdc-perfs-core Show documentation

There is a newer version: 0.52.0

package cdc.perfs.core;

import cdc.util.encoding.Encoded;
import cdc.util.encoding.Encoder;
import cdc.util.encoding.Encoders;

/**
 * Enumeration of possible measure statuses.
 *
 * @author Damien Carbonne
 */
public enum MeasureStatus implements Encoded {
    /**
     * The measure has been started by the associated probe and is still
     * running.
     */
    RUNNING("Running", 'R'),

    /**
     * The measure has been normally ended by the associated probe and wont
     * evolve anymore.
     */
    FROZEN("Frozen", 'F'),

    /**
     * The measure has been closed because of an error:
     * 
     * Another higher level measure was ended before the associated one
     * is ended.
     * The associated probe was started and it was already running.
     * The associated probe was ended and it was not running.
     * This indicates that the associated probe forgot to end its measure.
     * 
     * 
     */
    FROZEN_ON_ERROR("Error", 'E');

    private final String label;
    private final Character code;

    private MeasureStatus(String label,
                          char code) {
        this.label = label;
        this.code = code;
    }

    public static final Encoder ENCODER = Encoders.encoder(MeasureStatus.class, Character.class);

    @Override
    public Character getCode() {
        return code;
    }

    public String getLabel() {
        return label;
    }

    /**
     * @return True if this status is frozen (FROZEN or FROZEN_ON_ERROR).
     */
    public boolean isFrozen() {
        return this != RUNNING;
    }
}