org.eclipse.ohf.stem.internal.data
Class ISOKey

java.lang.Object
  extended by org.eclipse.ohf.stem.internal.data.ISOKey
All Implemented Interfaces:
java.lang.Comparable<ISOKey>

public class ISOKey
extends java.lang.Object
implements java.lang.Comparable<ISOKey>

This class represents an ISO-3166-1 alpha3 or alpha2 country key (or combination).


Field Summary
static ISOKey EARTH
          This is the ISO key used to represent The Earth
 
Constructor Summary
ISOKey(java.lang.String key)
           
 
Method Summary
 int compareTo(ISOKey isoKey)
           
 boolean equals(java.lang.Object obj)
           
 java.lang.String getKey()
           
 int hashCode()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

EARTH

public static final ISOKey EARTH
This is the ISO key used to represent The Earth

Constructor Detail

ISOKey

public ISOKey(java.lang.String key)
Parameters:
key - the key
Method Detail

getKey

public final java.lang.String getKey()
Returns:
the key

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object
See Also:
Object.hashCode()

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object
See Also:
Object.equals(java.lang.Object)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
See Also:
Object.toString()

compareTo

public int compareTo(ISOKey isoKey)
Specified by:
compareTo in interface java.lang.Comparable<ISOKey>
Parameters:
isoKey - the key to compare to
Returns:
the value of string compareTo
See Also:
Comparable.compareTo(java.lang.Object)