com.inet.jortho.UserDictionaryProvider Maven / Gradle / Ivy

Go to download
/*
 *  JOrtho
 *
 *  Copyright (C) 2005-2008 by i-net software
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License as 
 *  published by the Free Software Foundation; either version 2 of the
 *  License, or (at your option) any later version. 
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 *  USA.
 *  
 *  Created on 10.12.2007
 */
package com.inet.jortho;

/**
 * Interface to be implemented by a user dictionary. Adding a new word via {@link #addWord(String)} must
 * trigger a storing of the dictionary.
 * 
 * @author Volker Berlin
 */
public interface UserDictionaryProvider extends CustomDictionaryProvider{

    /**
     * Adds a new word to the current user dictionary. The implementor must save this word in its own backend.
     * 
     * @param word the new word.
     */
    void addWord( String word );

    /**
     * Set a completely new word list
     * 
     * @param wordList
     *            the new word list. Can be empty but not null.
     */
    void setUserWords( String wordList );

}