au.com.swz.jatlom
Class TypeDesc

java.lang.Object
  extended by au.com.swz.jatlom.TypeDesc

public class TypeDesc
extends java.lang.Object

Describes the type of a variable, the return type of a function, or the type of a function parameter.

Author:
Mark Richter

Constructor Summary
TypeDesc()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
          Checks this type description with equality to the specified object.
 boolean equals(TypeDesc typeDesc)
          Checks this type description with equality to the specified type description.
 TypeDesc getPointedToType()
          If getType() = VT_PTR this method returns a reference to the pointed to type.
 TypeDesc getSafeArrayType()
          If getType() = VT_SAFEARRAY this method returns a reference to the type of the safearray.
 VarType getType()
          The actual type.
 ITypeInfo getUserDefinedType()
          If getType() = VT_USERDEFINED this method returns a reference to the user defined type.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TypeDesc

public TypeDesc()
Method Detail

getPointedToType

public TypeDesc getPointedToType()
If getType() = VT_PTR this method returns a reference to the pointed to type. If getType() != VT_PTR this method returns null.

Returns:
a reference to the pointed to type.

getSafeArrayType

public TypeDesc getSafeArrayType()
If getType() = VT_SAFEARRAY this method returns a reference to the type of the safearray. If getType() != VT_SFAFEARRAY this method returns null.

Returns:
a reference to the pointed to type.

getType

public VarType getType()
The actual type.

Returns:
the actual type.

getUserDefinedType

public ITypeInfo getUserDefinedType()
If getType() = VT_USERDEFINED this method returns a reference to the user defined type. If getType() != VT_USERDEFINED this method returns null.

Returns:
a reference to the user defined type.

equals

public boolean equals(java.lang.Object obj)
Checks this type description with equality to the specified object. If the object is not of type TypeDesc then this method returns false.

Overrides:
equals in class java.lang.Object
Returns:
true if this object equals the specified object.

equals

public boolean equals(TypeDesc typeDesc)
Checks this type description with equality to the specified type description. If all fields in the specified type description are identical to this one then this method returns true otherwise it returns false.

Returns:
true if all fields in the specified type description are identical to this one.