001: /*
002: * Copyright 2003-2004 Sun Microsystems, Inc. All Rights Reserved.
003: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004: *
005: * This code is free software; you can redistribute it and/or modify it
006: * under the terms of the GNU General Public License version 2 only, as
007: * published by the Free Software Foundation. Sun designates this
008: * particular file as subject to the "Classpath" exception as provided
009: * by Sun in the LICENSE file that accompanied this code.
010: *
011: * This code is distributed in the hope that it will be useful, but WITHOUT
012: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014: * version 2 for more details (a copy is included in the LICENSE file that
015: * accompanied this code).
016: *
017: * You should have received a copy of the GNU General Public License version
018: * 2 along with this work; if not, write to the Free Software Foundation,
019: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020: *
021: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022: * CA 95054 USA or visit www.sun.com if you need additional information or
023: * have any questions.
024: */
025:
026: package sun.management.counter;
027:
028: /**
029: * Provides a typesafe enumeration for describing units of measurement
030: * attribute for instrumentation objects.
031: *
032: * @author Brian Doherty
033: * @version 1.10, 05/05/07
034: */
035: public class Units implements java.io.Serializable {
036:
037: /* The enumeration values for this typesafe enumeration must be
038: * kept in synchronization with the Units enum in the perfData.hpp file
039: * in the HotSpot source base.
040: */
041:
042: private static final int NUNITS = 8;
043:
044: private static Units[] map = new Units[NUNITS];
045:
046: private final String name;
047: private final int value;
048:
049: /**
050: * An Invalid Units value.
051: */
052: public static final Units INVALID = new Units("Invalid", 0);
053:
054: /**
055: * Units attribute representing unit-less quantities.
056: */
057: public static final Units NONE = new Units("None", 1);
058:
059: /**
060: * Units attribute representing Bytes.
061: */
062: public static final Units BYTES = new Units("Bytes", 2);
063:
064: /**
065: * Units attribute representing Ticks.
066: */
067: public static final Units TICKS = new Units("Ticks", 3);
068:
069: /**
070: * Units attribute representing a count of events.
071: */
072: public static final Units EVENTS = new Units("Events", 4);
073:
074: /**
075: * Units attribute representing String data. Although not really
076: * a unit of measure, this Units value serves to distinguish String
077: * instrumentation objects from instrumentation objects of other types.
078: */
079: public static final Units STRING = new Units("String", 5);
080:
081: /**
082: * Units attribute representing Hertz (frequency).
083: */
084: public static final Units HERTZ = new Units("Hertz", 6);
085:
086: /**
087: * Returns a string describing this Unit of measurement attribute
088: *
089: * @return String - a descriptive string for this enum.
090: */
091: public String toString() {
092: return name;
093: }
094:
095: /**
096: * Returns the integer representation of this Units attribute
097: *
098: * @return int - an integer representation of this Units attribute.
099: */
100: public int intValue() {
101: return value;
102: }
103:
104: /**
105: * Maps an integer value to its corresponding Units attribute.
106: * If the integer value does not have a corresponding Units enum
107: * value, then {@link Units#INVALID} is returned.
108: *
109: * @param value an integer representation of counter Units
110: * @return Units - the Units object for the given <code>value</code>
111: * or {@link Units#INVALID} if out of range.
112: */
113: public static Units toUnits(int value) {
114:
115: if (value < 0 || value >= map.length || map[value] == null) {
116: return INVALID;
117: }
118:
119: return map[value];
120: }
121:
122: private Units(String name, int value) {
123: this .name = name;
124: this .value = value;
125: map[value] = this ;
126: }
127:
128: private static final long serialVersionUID = 6992337162326171013L;
129: }
|