Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

normal.engine.implementation.corba
Class CORBAShareableObject  view CORBAShareableObject download CORBAShareableObject.java

java.lang.Object
  extended bynormal.engine.implementation.corba.CORBAShareableObject
All Implemented Interfaces:
normal.engine.ShareableObject

public class CORBAShareableObject
extends java.lang.Object
implements normal.engine.ShareableObject

Java object associated with an object in an external C++ CORBA server.

The protected member cppPtr is a memory pointer to the external C++ object. Through this member variable, a C++ implementation of a native method that is passed only the Java object can thus access the corresponding native C++ object.

When a new derivative of JNIShareableObject is created, many constructors may be called. The corresponding native C++ object should not be created in more than one of these constructors. Thus every derivative of JNIShareableObject should provide a constructor taking a single Sentry argument that does absolutely nothing. All initialisation and creation of native C++ objects should take place in a constructor for the most derived class, and every constructor should call the do-nothing constructor for its parent class.


Field Summary
static java.lang.Class CORBAClass
          The CORBA client class corresponding to this wrapper class.
 normal.engine.implementation.corba.Regina.ShareableObject data
          The CORBA client object for the underlying engine object that we are wrapping.
static java.lang.Class helperClass
          The CORBA helper class corresponding to this wrapper class.
 
Constructor Summary
protected CORBAShareableObject(normal.engine.implementation.corba.Regina.ShareableObject data)
          Creates a new wrapper for the given object.
 
Method Summary
 normal.engine.ShareableObject castAs(java.lang.Class cls)
           
 void destroy()
           
 boolean equals(java.lang.Object obj)
          Determine whether this Object is semantically equal to another Object.
 boolean sameObject(normal.engine.ShareableObject object)
           
static java.math.BigInteger stringToLarge(java.lang.String value)
          Converts the given string to a BigInteger.
 java.lang.String toString()
          Convert this Object to a human-readable String.
 java.lang.String toStringLong()
           
 void writeTextLong()
           
 void writeTextShort()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

data

public normal.engine.implementation.corba.Regina.ShareableObject data
The CORBA client object for the underlying engine object that we are wrapping.


CORBAClass

public static final java.lang.Class CORBAClass
The CORBA client class corresponding to this wrapper class.


helperClass

public static final java.lang.Class helperClass
The CORBA helper class corresponding to this wrapper class.

Constructor Detail

CORBAShareableObject

protected CORBAShareableObject(normal.engine.implementation.corba.Regina.ShareableObject data)
Creates a new wrapper for the given object.

Method Detail

stringToLarge

public static java.math.BigInteger stringToLarge(java.lang.String value)
Converts the given string to a BigInteger. If the given string is inf, null will be returned. Otherwise the string will be interpreted as the decimal representation of a large integer and the corresponding BigInteger will be returned.


sameObject

public boolean sameObject(normal.engine.ShareableObject object)
Specified by:
sameObject in interface normal.engine.ShareableObject

equals

public boolean equals(java.lang.Object obj)
Description copied from class: java.lang.Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.


castAs

public normal.engine.ShareableObject castAs(java.lang.Class cls)
Specified by:
castAs in interface normal.engine.ShareableObject

destroy

public void destroy()
Specified by:
destroy in interface normal.engine.ShareableObject

writeTextShort

public void writeTextShort()
Specified by:
writeTextShort in interface normal.engine.ShareableObject

writeTextLong

public void writeTextLong()
Specified by:
writeTextLong in interface normal.engine.ShareableObject

toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Specified by:
toString in interface normal.engine.ShareableObject

toStringLong

public java.lang.String toStringLong()
Specified by:
toStringLong in interface normal.engine.ShareableObject