001: /*
002: * @(#)Number.java 1.34 06/10/10
003: *
004: * Copyright 1990-2006 Sun Microsystems, Inc. All Rights Reserved.
005: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
006: *
007: * This program is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU General Public License version
009: * 2 only, as published by the Free Software Foundation.
010: *
011: * This program is distributed in the hope that it will be useful, but
012: * WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * General Public License version 2 for more details (a copy is
015: * included at /legal/license.txt).
016: *
017: * You should have received a copy of the GNU General Public License
018: * version 2 along with this work; if not, write to the Free Software
019: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA
021: *
022: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
023: * Clara, CA 95054 or visit www.sun.com if you need additional
024: * information or have any questions.
025: *
026: */
027:
028: package java.lang;
029:
030: /**
031: * The abstract class <code>Number</code> is the superclass of classes
032: * <code>BigDecimal</code>, <code>BigInteger</code>,
033: * <code>Byte</code>, <code>Double</code>, <code>Float</code>,
034: * <code>Integer</code>, <code>Long</code>, and <code>Short</code>.
035: * NOTE: <B>java.math.BigDecimal</B> is found in J2ME CDC profiles such as
036: * J2ME Foundation Profile.
037: * <p>
038: * Subclasses of <code>Number</code> must provide methods to convert
039: * the represented numeric value to <code>byte</code>, <code>double</code>,
040: * <code>float</code>, <code>int</code>, <code>long</code>, and
041: * <code>short</code>.
042: *
043: * @author Lee Boynton
044: * @author Arthur van Hoff
045: * @version 1.25, 02/02/00
046: * @see java.lang.Byte
047: * @see java.lang.Double
048: * @see java.lang.Float
049: * @see java.lang.Integer
050: * @see java.lang.Long
051: * @see java.lang.Short
052: * @since JDK1.0
053: */
054: public abstract class Number implements java.io.Serializable {
055: /**
056: * Returns the value of the specified number as an <code>int</code>.
057: * This may involve rounding or truncation.
058: *
059: * @return the numeric value represented by this object after conversion
060: * to type <code>int</code>.
061: */
062: public abstract int intValue();
063:
064: /**
065: * Returns the value of the specified number as a <code>long</code>.
066: * This may involve rounding or truncation.
067: *
068: * @return the numeric value represented by this object after conversion
069: * to type <code>long</code>.
070: */
071: public abstract long longValue();
072:
073: /**
074: * Returns the value of the specified number as a <code>float</code>.
075: * This may involve rounding.
076: *
077: * @return the numeric value represented by this object after conversion
078: * to type <code>float</code>.
079: */
080: public abstract float floatValue();
081:
082: /**
083: * Returns the value of the specified number as a <code>double</code>.
084: * This may involve rounding.
085: *
086: * @return the numeric value represented by this object after conversion
087: * to type <code>double</code>.
088: */
089: public abstract double doubleValue();
090:
091: /**
092: * Returns the value of the specified number as a <code>byte</code>.
093: * This may involve rounding or truncation.
094: *
095: * @return the numeric value represented by this object after conversion
096: * to type <code>byte</code>.
097: * @since JDK1.1
098: */
099: public byte byteValue() {
100: return (byte) intValue();
101: }
102:
103: /**
104: * Returns the value of the specified number as a <code>short</code>.
105: * This may involve rounding or truncation.
106: *
107: * @return the numeric value represented by this object after conversion
108: * to type <code>short</code>.
109: * @since JDK1.1
110: */
111: public short shortValue() {
112: return (short) intValue();
113: }
114:
115: /** use serialVersionUID from JDK 1.0.2 for interoperability */
116: private static final long serialVersionUID = -8742448824652078965L;
117: }
|