java.lang.Byte Maven / Gradle / Ivy
/*
This is not an official specification document, and usage is restricted.
NOTICE
(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 219: Foundation
Profile 1.1. In the event of a discrepency between this work and the
JSR 219 specification, which is available at
http://www.jcp.org/en/jsr/detail?id=219, the latter takes precedence.
*/
package java.lang;
/**
* The Byte class wraps a value of primitive type
* byte in an object. An object of type
* Byte contains a single field whose type is
* byte.
*
*
*
* In addition, this class provides several methods for converting a
* byte to a String and a String
* to a byte, as well as other constants and methods
* useful when dealing with a byte.
*
* @author Nakul Saraiya
* @version 1.20, 02/02/00
* @see java.lang.Number
* @since JDK1.1
*/
public final class Byte extends java.lang.Number implements java.lang.Comparable
{
/**
* A constant holding the minimum value a byte can
* have, -27.
*/
public static final byte MIN_VALUE = -128;
/**
* A constant holding the maximum value a byte can
* have, 27-1.
*/
public static final byte MAX_VALUE = 127;
/**
* The Class instance representing the primitive type
* byte.
*/
public static final java.lang.Class TYPE = null;
/**
* The value of the Byte.
*
* @serial
*/
private byte value;
/**
* Constructs a newly allocated Byte object that
* represents the specified byte value.
*
* @param value the value to be represented by the
* Byte.
*/
public Byte(byte value) { }
/**
* Constructs a newly allocated Byte object that
* represents the byte value indicated by the
* String parameter. The string is converted to a
* byte value in exactly the manner used by the
* parseByte method for radix 10.
*
* @param s the String to be converted to a
* Byte
* @exception NumberFormatException If the String
* does not contain a parsable byte.
* @see java.lang.Byte#parseByte(java.lang.String, int)
*/
public Byte(java.lang.String s) throws java.lang.NumberFormatException { }
/**
* Returns a new String object representing the
* specified byte. The radix is assumed to be 10.
*
* @param b the byte to be converted
* @return the string representation of the specified byte
* @see java.lang.Integer#toString(int)
*/
public static java.lang.String toString(byte b) {
return null;
}
/**
* Parses the string argument as a signed decimal
* byte. The characters in the string must all be
* decimal digits, except that the first character may be an ASCII
* minus sign '-' ('\u002D') to
* indicate a negative value. The resulting byte value is
* returned, exactly as if the argument and the radix 10 were
* given as arguments to the {@link #parseByte(java.lang.String,
* int)} method.
*
* @param s a String containing the
* byte representation to be parsed
* @return the byte value represented by the
* argument in decimal
* @exception NumberFormatException if the the string does not
* contain a parsable byte.
*/
public static byte parseByte(java.lang.String s)
throws java.lang.NumberFormatException
{
return ' ';
}
/**
* Parses the string argument as a signed byte in the
* radix specified by the second argument. The characters in the
* string must all be digits, of the specified radix (as
* determined by whether {@link java.lang.Character#digit(char,
* int)} returns a nonnegative value) except that the first
* character may be an ASCII minus sign '-'
* ('\u002D') to indicate a negative value. The
* resulting byte value is returned.
*
* An exception of type NumberFormatException is
* thrown if any of the following situations occurs:
*
* - The first argument is
null or is a string of
* length zero.
*
* - The radix is either smaller than {@link
* java.lang.Character#MIN_RADIX} or larger than {@link
* java.lang.Character#MAX_RADIX}.
*
*
- Any character of the string is not a digit of the specified
* radix, except that the first character may be a minus sign
*
'-' ('\u002D') provided that the
* string is longer than length 1.
*
* - The value represented by the string is not a value of type
*
byte.
*
*
* @param s the String containing the
* byte
* representation to be parsed
* @param radix the radix to be used while parsing s
* @return the byte value represented by the string
* argument in the specified radix
* @exception NumberFormatException If the string does
* not contain a parsable byte.
*/
public static byte parseByte(java.lang.String s, int radix)
throws java.lang.NumberFormatException
{
return ' ';
}
/**
* Returns a Byte object holding the value
* extracted from the specified String when parsed
* with the radix given by the second argument. The first argument
* is interpreted as representing a signed byte in
* the radix specified by the second argument, exactly as if the
* argument were given to the {@link #parseByte(java.lang.String,
* int)} method. The result is a Byte object that
* represents the byte value specified by the string.
* In other words, this method returns a Byte object
* equal to the value of:
*
*
* new Byte(Byte.parseByte(s, radix))
*
*
* @param s the string to be parsed
* @param radix the radix to be used in interpreting s
* @return a Byte object holding the value
* represented by the string argument in the
* specified radix.
* @exception NumberFormatException If the String does
* not contain a parsable byte.
*/
public static java.lang.Byte valueOf(java.lang.String s, int radix)
throws java.lang.NumberFormatException
{
return null;
}
/**
* Returns a Byte object holding the value
* given by the specified String. The argument is
* interpreted as representing a signed decimal byte,
* exactly as if the argument were given to the {@link
* #parseByte(java.lang.String)} method. The result is a
* Byte object that represents the byte
* value specified by the string. In other words, this method
* returns a Byte object equal to the value of:
*
*
* new Byte(Byte.parseByte(s))
*
*
* @param s the string to be parsed
* @return a Byte object holding the value
* represented by the string argument
* @exception NumberFormatException If the String does
* not contain a parsable byte.
*/
public static java.lang.Byte valueOf(java.lang.String s)
throws java.lang.NumberFormatException
{
return null;
}
/**
* Decodes a String into a Byte.
* Accepts decimal, hexadecimal, and octal numbers given by
* the following grammar:
*
*
*
* - DecodableString:
*
- Signopt DecimalNumeral
*
- Signopt
0x HexDigits
* - Signopt
0X HexDigits
* - Signopt
# HexDigits
* - Signopt
0 OctalDigits
*
*
- Sign:
*
-
*
*
*
* DecimalNumeral, HexDigits, and OctalDigits
* are defined in §3.10.1
* of the Java
* Language Specification.
*
* The sequence of characters following an (optional) negative
* sign and/or radix specifier ("0x",
* "0X", "#", or
* leading zero) is parsed as by the Byte.parseByte
* method with the indicated radix (10, 16, or 8). This sequence
* of characters must represent a positive value or a {@link
* NumberFormatException} will be thrown. The result is negated
* if first character of the specified String is the
* minus sign. No whitespace characters are permitted in the
* String.
*
* @param nm the String to decode.
* @return a Byte object holding the byte
* value represented by nm
* @exception NumberFormatException if the String does not
* contain a parsable byte.
* @see java.lang.Byte#parseByte(java.lang.String, int)
*/
public static java.lang.Byte decode(java.lang.String nm)
throws java.lang.NumberFormatException
{
return null;
}
/**
* Returns the value of this Byte as a
* byte.
*/
public byte byteValue() {
return ' ';
}
/**
* Returns the value of this Byte as a
* short.
*/
public short shortValue() {
return -1;
}
/**
* Returns the value of this Byte as an
* int.
*/
public int intValue() {
return 0;
}
/**
* Returns the value of this Byte as a
* long.
*/
public long longValue() {
return -1;
}
/**
* Returns the value of this Byte as a
* float.
*/
public float floatValue() {
return 0.0f;
}
/**
* Returns the value of this Byte as a
* double.
*/
public double doubleValue() {
return 0.0d;
}
/**
* Returns a String object representing this
* Byte's value. The value is converted to signed
* decimal representation and returned as a string, exactly as if
* the byte value were given as an argument to the
* {@link java.lang.Byte#toString(byte)} method.
*
* @return a string representation of the value of this object in
* base 10.
*/
public java.lang.String toString() {
return null;
}
/**
* Returns a hash code for this Byte.
*/
public int hashCode() {
return 0;
}
/**
* Compares this object to the specified object. The result is
* true if and only if the argument is not
* null and is a Byte object that
* contains the same byte value as this object.
*
* @param obj the object to compare with
* @return true if the objects are the same;
* false otherwise.
*/
public boolean equals(java.lang.Object obj) {
return false;
}
/**
* Compares two Byte objects numerically.
*
* @param anotherByte the Byte to be compared.
* @return the value 0 if this Byte is
* equal to the argument Byte; a value less than
* 0 if this Byte is numerically less
* than the argument Byte; and a value greater than
* 0 if this Byte is numerically
* greater than the argument Byte (signed
* comparison).
* @since 1.2
*/
public int compareTo(java.lang.Byte anotherByte) {
return 0;
}
/**
* Compares this Byte object to another object. If the
* object is a Byte, this function behaves like
* compareTo(Byte). Otherwise, it throws a
* ClassCastException (as Byte objects
* are only comparable to other Byte objects).
*
* @param o the Object to be compared.
* @return the value 0 if the argument is a Byte
* numerically equal to this Byte; a value less than
* 0 if the argument is a Byte
* numerically greater than this Byte; and a
* value greater than 0 if the argument is a
* Byte numerically less than this
* Byte.
* @exception ClassCastException if the argument is not a
* Byte