Java example source code file (Variability.java)

This example Java source code file (Variability.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

constant, invalid, monotonic, nattributes, string, variability, variable

The Variability.java Java example source code

/*
 * Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package sun.management.counter;

/**
 * Provides a typesafe enumeration for the Variability attribute for
 * instrumentation objects.
 *
 * @author   Brian Doherty
 */
public class Variability implements java.io.Serializable {

    /* The enumeration values for this typesafe enumeration must be
     * kept in synchronization with the Variability enum in the perfData.hpp file
     * in the HotSpot source base.
     */

    private static final int NATTRIBUTES = 4;
    private static Variability[] map = new Variability[NATTRIBUTES];

    private String name;
    private int value;

    /**
     * An invalid Variablity value.
     */
    public static final Variability INVALID = new Variability("Invalid",0);

    /**
     * Variability attribute representing Constant counters.
     */
    public static final Variability CONSTANT = new Variability("Constant",1);

    /**
     * Variability attribute representing a Monotonically changing counters.
     */
    public static final Variability MONOTONIC = new Variability("Monotonic",2);

    /**
     * Variability attribute representing Variable counters.
     */
    public static final Variability VARIABLE = new Variability("Variable",3);

    /**
     * Returns a string describing this Variability attribute.
     *
     * @return String - a descriptive string for this enum.
     */
    public String toString() {
        return name;
    }

    /**
     * Returns the integer representation of this Variability attribute.
     *
     * @return int - an integer representation of this Variability attribute.
     */
    public int intValue() {
        return value;
    }

    /**
     * Maps an integer value its corresponding Variability attribute.
     * If the integer value does not have a corresponding Variability enum
     * value, the {@link Variability#INVALID} is returned
     *
     * @param value an integer representation of a Variability attribute
     * @return Variability - The Variability object for the given
     *                       <code>value or {@link Variability#INVALID}
     *                       if out of range.
     */
    public static Variability toVariability(int value) {

        if (value < 0 || value >= map.length || map[value] == null) {
            return INVALID;
        }

        return map[value];
    }

    private Variability(String name, int value) {
        this.name = name;
        this.value = value;
        map[value]=this;
    }

    private static final long serialVersionUID = 6992337162326171013L;
}