java::lang::Byte Class Reference

The Byte class wraps a value of primitive type byte in an object. More...

#include <java_lang_Byte.h>

Inheritance diagram for java::lang::Byte:

[legend]Collaboration diagram for java::lang::Byte:

[legend]List of all members.

Public Types
enum	{   xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9,   xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::java::lang::Byte >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::java::lang::Byte > >	array2D
Public Member Functions
	Byte (const ::java::lang::String &s,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Constructs a newly allocated Byte object that represents the byte value indicated by the String parameter.
	Byte (jbyte value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Constructs a newly allocated Byte object that represents the specified byte value.
jbyte	byteValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the value of this Byte as a byte.
jint	compareTo (const ::java::lang::Byte &anotherByte,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Compares two Byte objects numerically.
jint	compareTo (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Compares this Byte object to another object.
jdouble	doubleValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the value of this Byte as a double.
bool	equals (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Compares this object to the specified object.
jfloat	floatValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the value of this Byte as a float.
jint	hashCode (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a hash code for this Byte.
jint	intValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the value of this Byte as an int.
jlong	longValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the value of this Byte as a long.
jshort	shortValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the value of this Byte as a short.
::java::lang::String	toString (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a String object representing this Byte's value.
Static Public Member Functions
::java::lang::Byte	decode (const ::java::lang::String &nm,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Decodes a String into a Byte.
static jbyte	parseByte (const ::java::lang::String &s, jint radix,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Parses the string argument as a signed byte in the radix specified by the second argument.
static jbyte	parseByte (const ::java::lang::String &s,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Parses the string argument as a signed decimal byte.
::java::lang::String	toString (jbyte b,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a new String object representing the specified byte.
::java::lang::Byte	valueOf (const ::java::lang::String &s, jint radix,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a Byte object holding the value extracted from the specified String when parsed with the radix given by the second argument.
::java::lang::Byte	valueOf (const ::java::lang::String &s,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a Byte object holding the value given by the specified String.
Static Public Attributes
static xmog_byte	MAX_VALUE
	A constant holding the maximum value a byte can have, 27-1.
static xmog_byte	MIN_VALUE
	A constant holding the minimum value a byte can have, -27.
::java::lang::Class	TYPE
	The Class instance representing the primitive type byte.

---

Detailed Description

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

---

Constructor & Destructor Documentation

java::lang::Byte::Byte (  jbyte  value, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Constructs a newly allocated Byte object that represents the specified byte value. Parameters: value  the value to be represented by the Byte. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

java::lang::Byte::Byte (  const ::java::lang::String &  s, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

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. Parameters: s  the String to be converted to a Byte p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

---

Member Function Documentation

jbyte java::lang::Byte::byteValue (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Returns the value of this Byte as a byte. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::Number.

jint java::lang::Byte::compareTo (  const ::java::lang::Byte &  anotherByte, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Compares two Byte objects numerically. Parameters: anotherByte  the Byte to be compared. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: 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).

jint java::lang::Byte::compareTo (  const ::java::lang::Object &  o, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

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). Parameters: o  the Object to be compared. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: 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. Reimplemented from java::lang::Comparable.

::java::lang::Byte java::lang::Byte::decode (  const ::java::lang::String &  nm, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [static]

Decodes a String into a Byte. Accepts decimal, hexadecimal, and octal numbers given by the following grammar: <blockquote> DecodableString: Signopt DecimalNumeral Signopt 0x HexDigits Signopt 0X HexDigits Signopt # HexDigits Signopt 0 OctalDigits Sign: - </blockquote> 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 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. Parameters: nm  the String to decode. p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: a Byte object holding the byte value represented by nm

jdouble java::lang::Byte::doubleValue (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Returns the value of this Byte as a double. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::Number.

bool java::lang::Byte::equals (  const ::java::lang::Object &  obj, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

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. Parameters: obj  the object to compare with p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: true if the objects are the same; false otherwise. Reimplemented from java::lang::Object.

jfloat java::lang::Byte::floatValue (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Returns the value of this Byte as a float. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::Number.

jint java::lang::Byte::hashCode (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Returns a hash code for this Byte. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::Object.

jint java::lang::Byte::intValue (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Returns the value of this Byte as an int. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::Number.

jlong java::lang::Byte::longValue (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Returns the value of this Byte as a long. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::Number.

static jbyte java::lang::Byte::parseByte (  const ::java::lang::String &  s, jint  radix, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [static]

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 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 or larger than . 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. Parameters: s  the String containing the byte representation to be parsed radix  the radix to be used while parsing s p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the byte value represented by the string argument in the specified radix

static jbyte java::lang::Byte::parseByte (  const ::java::lang::String &  s, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [static]

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 method. Parameters: s  a String containing the byte representation to be parsed p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the byte value represented by the argument in decimal

jshort java::lang::Byte::shortValue (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Returns the value of this Byte as a short. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: Reimplemented from java::lang::Number.

::java::lang::String java::lang::Byte::toString (  jbyte  b, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [static]

Returns a new String object representing the specified byte. The radix is assumed to be 10. Parameters: b  the byte to be converted p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the string representation of the specified byte

::java::lang::String java::lang::Byte::toString (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

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 method. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: a string representation of the value of this object in base 10. Reimplemented from java::lang::Object.

::java::lang::Byte java::lang::Byte::valueOf (  const ::java::lang::String &  s, jint  radix, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [static]

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 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: <blockquote> new Byte(Byte.parseByte(s, radix)) </blockquote> Parameters: s  the string to be parsed radix  the radix to be used in interpreting s p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: a Byte object holding the value represented by the string argument in the specified radix.

::java::lang::Byte java::lang::Byte::valueOf (  const ::java::lang::String &  s, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [static]

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 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: <blockquote> new Byte(Byte.parseByte(s)) </blockquote> Parameters: s  the string to be parsed p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: a Byte object holding the value represented by the string argument

---

The documentation for this class was generated from the following file:

• java_lang_Byte.h

---