Package weblogic.wtc.jatmi

Class FmlKey

java.lang.Object

weblogic.wtc.jatmi.FmlKey

All Implemented Interfaces:

java.lang.Comparable

public final class FmlKey
extends java.lang.Object
implements java.lang.Comparable

This class represents the combination of FML field id and occurance.

See Also:

FML, mkfldclass

Method Summary

Modifier and Type	Method	Description
int	compareTo(java.lang.Object obj)	orders two FmlKey objects
boolean	equals(java.lang.Object obj)	Compares two FmlKey objects
int	get_fldid()	Returns the field id associated with this key
int	get_occurance()	Deprecated. As of 9.2, replaced by get_occurrence().
int	get_occurrence()	Returns the occurrence number associated with this key
int	hashCode()	return hash code value
void	set_occurance(int occurrence)	Deprecated. As of 9.2, replaced by set_occurrence(int occurrence).
void	set_occurrence(int occurrence)	sets the occurrence number of this key
java.lang.String	toString()	Returns a string version of this object.

Methods inherited from class java.lang.Object

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

Method Detail

get_fldid

public int get_fldid()

Returns the field id associated with this key

Returns:

the field id associated with this key

get_occurrence

public int get_occurrence()

Returns the occurrence number associated with this key

Returns:

the occurrence number associated with this key

get_occurance

@Deprecated
public int get_occurance()

Deprecated.

As of 9.2, replaced by get_occurrence().

Returns the occurrence number associated with this key

Returns:

the occurrence number associated with this key

set_occurrence

public void set_occurrence(int occurrence)

sets the occurrence number of this key

Parameters:

occurrence - The occurrence number for this key

set_occurance

@Deprecated
public void set_occurance(int occurrence)

Deprecated.

As of 9.2, replaced by set_occurrence(int occurrence).

sets the occurance number of this key

Parameters:

occurrence - The occurance number for this key

equals

public boolean equals(java.lang.Object obj)

Compares two FmlKey objects

Overrides:

equals in class java.lang.Object

Parameters:

obj - An object to compare to this object

Returns:

true if the objects are equal, false otherwise

toString

public java.lang.String toString()

Returns a string version of this object. The string version consists of the fldid and occurance number.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of a FmlKey object

hashCode

public int hashCode()

return hash code value

Overrides:

hashCode in class java.lang.Object

Returns:

the int value of hash code.

compareTo

public int compareTo(java.lang.Object obj)

orders two FmlKey objects

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

obj - The FmlKey object to compare to this one

Returns:

-1 if this object comes before obj, 0 if they are equal and 1 if this object comes after obj