
class HashableString(object):
    '''
    This class is a super-trivial example of data that could be stored in a hash structure.
    We have intentionally simplified the idea so that you can give specific hash values to test
    different scenarios.
    
    @author: Otto Sepp\u00E4l\u00E4, santtu
    '''

    def __init__(self, value, key):
        '''
        Creates a new HashableString with the requested data and hash value.
         
        @param value: The string contained in this HashableString.
        @param key: The hash value to be used by the DoubleHash class.
        '''    
        self.value = value
        self.key   = key
    
    def get_value_to_hash(self):
        '''
        Returns the hash value for this item.
         
        @return: the hash value for this specific object.
        '''    
        return self.key
