com.metamatrix.common.jdbc.metadata
Class ProcedureType

java.lang.Object
  com.metamatrix.common.jdbc.metadata.ProcedureType

public class ProcedureType
extends java.lang.Object

Field Summary

static ProcedureType	NO_RESULT Null values may not be allowed.
static ProcedureType	RESULT_UNKNOWN Null values are definitiely allowed.
static ProcedureType	RETURNS_RESULT Whether Null values are allowed is unknown.

Method Summary

int	compareTo(java.lang.Object obj) Compares this object to another.
boolean	equals(java.lang.Object obj) Returns true if the specified object is semantically equal to this instance.
java.lang.String	getDisplayName() Return the display name for this type.
static ProcedureType	getInstance(int value)
static ProcedureType	getInstance(java.lang.String displayName)
int	hashCode() Returns the hash code value for this object.
java.lang.String	toString() Returns a string representing the current state of the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_RESULT

public static final ProcedureType NO_RESULT

Null values may not be allowed.

RESULT_UNKNOWN

public static final ProcedureType RESULT_UNKNOWN

Null values are definitiely allowed.

RETURNS_RESULT

public static final ProcedureType RETURNS_RESULT

Whether Null values are allowed is unknown.

Method Detail

getInstance

public static ProcedureType getInstance(java.lang.String displayName)

getInstance

public static ProcedureType getInstance(int value)

getDisplayName

public java.lang.String getDisplayName()

Return the display name for this type.

Returns:

the display name

compareTo

public int compareTo(java.lang.Object obj)

Compares this object to another. If the specified object is an instance of the MetaMatrixSessionID class, then this method compares the contents; otherwise, it throws a ClassCastException (as instances are comparable only to instances of the same class).

Note: this method is consistent with equals(), meaning that (compare(x, y)==0) == (x.equals(y)).

Parameters:

obj - the object that this instance is to be compared to.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object, respectively.

Throws:

java.lang.IllegalArgumentException - if the specified object reference is null

java.lang.ClassCastException - if the specified object's type prevents it from being compared to this instance.

equals

public boolean equals(java.lang.Object obj)

Returns true if the specified object is semantically equal to this instance. Note: this method is consistent with compareTo().

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object that this instance is to be compared to.

Returns:

whether the object is equal to this object.

hashCode

public final int hashCode()

Returns the hash code value for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

toString

public final java.lang.String toString()

Returns a string representing the current state of the object.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of this instance.