com.ibm.tws.objects.model
Class VariableKey

java.lang.Object
  extended bycom.ibm.tws.objects.model.VariableKey
All Implemented Interfaces:
java.io.Serializable, TWSKey

public class VariableKey
extends java.lang.Object
implements TWSKey

This object represents a variable external key, including fields used to identify a variable in TWS external interfaces.

See Also:
Variable, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
VariableKey()
          Creates an empty VariableKey.
VariableKey(java.lang.String variableName)
          Creates a VariableKey with the specified name.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this VariableKey object are equal to those of the given one.
 java.lang.String getName()
          Returns the variable name.
 int hashCode()
          Returns a hash code for this VariableKey object.
static VariableKey parseKey(java.lang.String key)
          Parses data from the specified string and creates a new VariableKey.
 void setName(java.lang.String string)
          Sets the variable name.
 java.lang.String toString()
          Returns a string representation of this VariableKey object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.

Constructor Detail

VariableKey

public VariableKey()
Creates an empty VariableKey.


VariableKey

public VariableKey(java.lang.String variableName)
Creates a VariableKey with the specified name.

Parameters:
variableName - The variable name.
Method Detail

parseKey

public static VariableKey parseKey(java.lang.String key)
Parses data from the specified string and creates a new VariableKey.

Parameters:
key - The string containing key data.
Returns:
A new VariableKey, or null if the string does not contain a valid key.

getName

public java.lang.String getName()
Returns the variable name.

Specified by:
getName in interface TWSKey
Returns:
The variable name.

setName

public void setName(java.lang.String string)
Sets the variable name.

Parameters:
string - The variable name.

equals

public boolean equals(java.lang.Object object)
Returns true if all fields of this VariableKey object are equal to those of the given one.

Parameters:
object - The object to be compared with this one.
Returns:
True if this object equals to the given one.

hashCode

public int hashCode()
Returns a hash code for this VariableKey object.

Returns:
The object's hash code.

toString

public java.lang.String toString()
Returns a string representation of this VariableKey object.

Returns:
A text string including all VariableKey fields.


Copyright © 2005 IBM All Rights Reserved.