net.sourceforge.phpeclipse.ui/src/net/sourceforge/phpdt/internal/ui/text/spelling/engine/IPhoneticHashProvider.java

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2003 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Common Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/cpl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  *******************************************************************************/
  11
  12 package net.sourceforge.phpdt.internal.ui.text.spelling.engine;
  13
  14 /**
  15  * Interface of hashers to compute the phonetic hash for a word.
  16  *
  17  * @since 3.0
  18  */
  19 public interface IPhoneticHashProvider {
  20
  21         /**
  22          * Returns the phonetic hash for the word.
  23          *
  24          * @param word
  25          *            The word to get the phonetic hash for
  26          * @return The phonetic hash for the word
  27          */
  28         public String getHash(String word);
  29
  30         /**
  31          * Returns an array of characters to compute possible mutations.
  32          *
  33          * @return Array of possible mutator characters
  34          */
  35         public char[] getMutators();
  36 }