java::lang::Object Class Reference

Class Object is the root of the class hierarchy. More...

#include <java_lang_Object.h>

Inheritance diagram for java::lang::Object:

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

[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::Object >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::java::lang::Object > >	array2D
Public Member Functions
virtual bool	equals (const ::java::lang::Object &obj,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Indicates whether some other object is "equal to" this one.
::java::lang::Class	getClass (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns the runtime class of an object.
virtual jint	hashCode (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a hash code value for the object.
void	notify (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Wakes up a single thread that is waiting on this object's monitor.
void	notifyAll (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Wakes up all threads that are waiting on this object's monitor.
	Object (::xmog_dummy _use_java_ctor,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
virtual ::java::lang::String	toString (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Returns a string representation of the object.
void	wait (jlong timeout,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Causes current thread to wait until either another thread invokes the method or the method for this object, or a specified amount of time has elapsed.
void	wait (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Causes current thread to wait until another thread invokes the method or the method for this object.

---

Detailed Description

Class Object is the root of the class hierarchy.

Every class has Object as a superclass. All objects, including arrays, implement the methods of this class.

Author:

unascribed

---

Constructor & Destructor Documentation

java::lang::Object::Object (  ::xmog_dummy  _use_java_ctor, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Parameters: _use_java_ctor  indicates that you want to delegate to a Java constructor whose natural proxy conflicts with a C++ requirement. 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

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

Indicates whether some other object is "equal to" this one. The equals method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value x, x.equals(x) should return true. It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true. It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true. It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified. For any non-null reference value x, x.equals(null) should return false. The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true). Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes. Parameters: obj  the reference object with which to compare. 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 this object is the same as the obj argument; false otherwise. Reimplemented in java::lang::Boolean, java::lang::Byte, java::lang::Character, java::lang::Character::Subset, java::lang::Double, java::lang::Float, java::lang::Integer, java::lang::Long, java::lang::reflect::Constructor, java::lang::reflect::Field, java::lang::reflect::Method, java::lang::Short, java::util::AbstractList, java::util::AbstractMap, java::util::AbstractSet, java::util::ArrayList, java::util::Collection, java::util::Date, java::util::HashMap, java::util::HashSet, java::util::Hashtable, java::util::List, java::util::Map, java::util::Set, and java::util::Vector.

::java::lang::Class java::lang::Object::getClass (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Returns the runtime class of an object. That Class object is the object that is locked by static synchronized methods of the represented class. 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: the object of type Class that represents the runtime class of the object.

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

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable. The general contract of hashCode is: Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables. As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java<font size="-2">TM</font> programming language.) 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 hash code value for this object. Reimplemented in java::lang::Boolean, java::lang::Byte, java::lang::Character, java::lang::Character::Subset, java::lang::Double, java::lang::Float, java::lang::Integer, java::lang::Long, java::lang::reflect::Constructor, java::lang::reflect::Field, java::lang::reflect::Method, java::lang::Short, java::util::AbstractList, java::util::AbstractMap, java::util::AbstractSet, java::util::ArrayList, java::util::Collection, java::util::HashMap, java::util::HashSet, java::util::Hashtable, java::util::List, java::util::Map, java::util::Set, and java::util::Vector.

void java::lang::Object::notify (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Wakes up a single thread that is waiting on this object's monitor. If any threads are waiting on this object, one of them is chosen to be awakened. The choice is arbitrary and occurs at the discretion of the implementation. A thread waits on an object's monitor by calling one of the wait methods. The awakened thread will not be able to proceed until the current thread relinquishes the lock on this object. The awakened thread will compete in the usual manner with any other threads that might be actively competing to synchronize on this object; for example, the awakened thread enjoys no reliable privilege or disadvantage in being the next thread to lock this object. This method should only be called by a thread that is the owner of this object's monitor. A thread becomes the owner of the object's monitor in one of three ways: By executing a synchronized instance method of that object. By executing the body of a synchronized statement that synchronizes on the object. For objects of type Class, by executing a synchronized static method of that class. Only one thread at a time can own an object's monitor. 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:

void java::lang::Object::notifyAll (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Wakes up all threads that are waiting on this object's monitor. A thread waits on an object's monitor by calling one of the wait methods. The awakened threads will not be able to proceed until the current thread relinquishes the lock on this object. The awakened threads will compete in the usual manner with any other threads that might be actively competing to synchronize on this object; for example, the awakened threads enjoy no reliable privilege or disadvantage in being the next thread to lock this object. This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor. 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:

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

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method. The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `</code>', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: <blockquote> getClass().getName() + '@' + Integer.toHexString(hashCode()) </blockquote> 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 object. Reimplemented in java::lang::Boolean, java::lang::Byte, java::lang::Character, java::lang::Character::Subset, java::lang::CharSequence, java::lang::Class, java::lang::Double, java::lang::Float, java::lang::Integer, java::lang::Long, java::lang::reflect::Constructor, java::lang::reflect::Field, java::lang::reflect::Method, java::lang::Short, java::lang::Throwable, java::util::AbstractCollection, java::util::AbstractList, java::util::AbstractMap, java::util::AbstractSet, java::util::ArrayList, java::util::HashMap, java::util::HashSet, java::util::Hashtable, java::util::Vector, javax::jms::Queue, javax::jms::Topic, and javax::naming::NamingException.

void java::lang::Object::wait (  jlong  timeout, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Causes current thread to wait until either another thread invokes the method or the method for this object, or a specified amount of time has elapsed. The current thread must own this object's monitor. This method causes the current thread (call it T) to place itself in the wait set for this object and then to relinquish any and all synchronization claims on this object. Thread T becomes disabled for thread scheduling purposes and lies dormant until one of four things happens: Some other thread invokes the notify method for this object and thread T happens to be arbitrarily chosen as the thread to be awakened. Some other thread invokes the notifyAll method for this object. Some other thread interrupts thread T. The specified amount of real time has elapsed, more or less. If timeout is zero, however, then real time is not taken into consideration and the thread simply waits until notified. The thread T is then removed from the wait set for this object and re-enabled for thread scheduling. It then competes in the usual manner with other threads for the right to synchronize on the object; once it has gained control of the object, all its synchronization claims on the object are restored to the status quo ante - that is, to the situation as of the time that the wait method was invoked. Thread T then returns from the invocation of the wait method. Thus, on return from the wait method, the synchronization state of the object and of thread T is exactly as it was when the wait method was invoked. If the current thread is interrupted by another thread while it is waiting, then an InterruptedException is thrown. This exception is not thrown until the lock status of this object has been restored as described above. Note that the wait method, as it places the current thread into the wait set for this object, unlocks only this object; any other objects on which the current thread may be synchronized remain locked while the thread waits. This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor. Parameters: timeout  the maximum time to wait in milliseconds. 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:

void java::lang::Object::wait (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Causes current thread to wait until another thread invokes the method or the method for this object. In other words, this method behaves exactly as if it simply performs the call wait(0). The current thread must own this object's monitor. The thread releases ownership of this monitor and waits until another thread notifies threads waiting on this object's monitor to wake up either through a call to the notify method or the notifyAll method. The thread then waits until it can re-obtain ownership of the monitor and resumes execution. This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor. 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:

---

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

• java_lang_Object.h

---