java::lang::Short

java::lang::Short Class Reference

The Short class wraps a value of primitive type short in an object. More...

#include <java_lang_Short.h>

Inheritance diagram for java::lang::Short:

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

[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::Short >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::java::lang::Short > >	array2D
Public Member Functions
jbyte	byteValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the value of this `Short` as a `byte`.
jint	compareTo (const ::java::lang::Short &anotherShort,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Compares two `Short` objects numerically.
jint	compareTo (const ::java::lang::Object &o,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Compares this `Short` object to another object.
jdouble	doubleValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the value of this `Short` 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 `Short` as a `float`.
jint	hashCode (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a hash code for this `Short`.
jint	intValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the value of this `Short` as an `int`.
jlong	longValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the value of this `Short` as a `long`.
	Short (const ::java::lang::String &s,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Constructs a newly allocated `Short` object that represents the `short` value indicated by the `String` parameter.
	Short (jshort value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Constructs a newly allocated `Short` object that represents the specified `short` value.
jshort	shortValue (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the value of this `Short` as a `short`.
::java::lang::String	toString (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a `String` object representing this `Short`'s value.
Static Public Member Functions
::java::lang::Short	decode (const ::java::lang::String &nm,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Decodes a `String` into a `Short`.
static jshort	parseShort (const ::java::lang::String &s, jint radix,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Parses the string argument as a signed `short` in the radix specified by the second argument.
static jshort	parseShort (const ::java::lang::String &s,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Parses the string argument as a signed decimal `short`.
::java::lang::String	toString (jshort s,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a new `String` object representing the specified `short`.
::java::lang::Short	valueOf (const ::java::lang::String &s, jint radix,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a `Short` object holding the value extracted from the specified `String` when parsed with the radix given by the second argument.
::java::lang::Short	valueOf (const ::java::lang::String &s,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a `Short` object holding the value given by the specified `String`.
Static Public Attributes
static xmog_short	MAX_VALUE
	A constant holding the maximum value a `short` can have, 2¹⁵-1.
static xmog_short	MIN_VALUE
	A constant holding the minimum value a `short` can have, -2¹⁵.
::java::lang::Class	TYPE
	The `Class` instance representing the primitive type `short`.

Detailed Description

The Short class wraps a value of primitive type short in an object.

An object of type Short contains a single field whose type is short.

In addition, this class provides several methods for converting a short to a String and a String to a short, as well as other constants and methods useful when dealing with a short.

Author:: Nakul Saraiya

Constructor & Destructor Documentation

java::lang::Short::Short ( jshort value,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Constructs a newly allocated Short object that represents the specified short value.

Parameters:

value the value to be represented by the Short.

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::Short::Short ( const ::java::lang::String & s,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Constructs a newly allocated Short object that represents the short value indicated by the String parameter.
The string is converted to a short value in exactly the manner used by the parseShort method for radix 10.

Parameters:

s the String to be converted to a Short

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::Short::byteValue ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Returns the value of this Short 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::Short::compareTo ( const ::java::lang::Short & anotherShort,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Compares two Short objects numerically.

Parameters:

anotherShort the Short 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 Short is equal to the argument Short; a value less than 0 if this Short is numerically less than the argument Short; and a value greater than 0 if this Short is numerically greater than the argument Short (signed comparison).

jint java::lang::Short::compareTo ( const ::java::lang::Object & o,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Compares this Short object to another object.
If the object is a Short, this function behaves like compareTo(Short). Otherwise, it throws a ClassCastException (as Short objects are only comparable to other Short 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 Short numerically equal to this Short; a value less than 0 if the argument is a Short numerically greater than this Short; and a value greater than 0 if the argument is a Short numerically less than this Short.

Reimplemented from java::lang::Comparable.

::java::lang::Short java::lang::Short::decode ( const ::java::lang::String & nm,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [static]

Decodes a String into a Short.
Accepts decimal, hexadecimal, and octal numbers given by the following grammar:
<blockquote>

DecodableString:

Sign_opt DecimalNumeral Sign_opt 0x HexDigits Sign_opt 0X HexDigits Sign_opt # HexDigits Sign_opt 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 Short.parseShort 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 Short object holding the short value represented by nm

jdouble java::lang::Short::doubleValue ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Returns the value of this Short 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::Short::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 Short object that contains the same short 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::Short::floatValue ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Returns the value of this Short 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::Short::hashCode ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Returns a hash code for this 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::Object.

jint java::lang::Short::intValue ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Returns the value of this Short 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::Short::longValue ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Returns the value of this Short 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 jshort java::lang::Short::parseShort ( 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 short 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 short.

Parameters:

s the String containing the short 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 short represented by the string argument in the specified radix.

static jshort java::lang::Short::parseShort ( const ::java::lang::String & s,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [static]

Parses the string argument as a signed decimal short.
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 short 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 short 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 short value represented by the argument in decimal.

jshort java::lang::Short::shortValue ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [virtual]

Returns the value of this Short 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::Short::toString ( jshort s,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [static]

Returns a new String object representing the specified short.
The radix is assumed to be 10.

Parameters:

s the short 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 short

::java::lang::String java::lang::Short::toString ( ::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

)

Returns a String object representing this Short's value.
The value is converted to signed decimal representation and returned as a string, exactly as if the short 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::Short java::lang::Short::valueOf ( const ::java::lang::String & s,

jint radix,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [static]

Returns a Short 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 short in the radix specified by the second argument, exactly as if the argument were given to the method. The result is a Short object that represents the short value specified by the string.
In other words, this method returns a Short object equal to the value of:
<blockquote> new Short(Short.parseShort(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 Short object holding the value represented by the string argument in the specified radix.

::java::lang::Short java::lang::Short::valueOf ( const ::java::lang::String & s,

::xmog_localenv * p_xenv = NULL,

xmog_flags f_xflags = xmogDefaultFlags

) [static]

Returns a Short object holding the value given by the specified String.
The argument is interpreted as representing a signed decimal short, exactly as if the argument were given to the method. The result is a Short object that represents the short value specified by the string.
In other words, this method returns a Byte object equal to the value of:
<blockquote> new Short(Short.parseShort(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 Short object holding the value represented by the string argument

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

java_lang_Short.h

Generated on Fri Jun 16 10:19:32 2006 for JMS Courier for C++ by

1.4.1

java::lang::Short Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation