/*
 Copyright (C) 2010-2015 The Open University
 Copyright (C) 2019 Simon Butler

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
*/

package uk.ac.open.crc.intt;

import java.util.List;

/**
 * An interface for a dictionary.
 *
 */
interface Dictionary {
    
    /**
     * Indicates whether the string passed in is found in the dictionary.
     * @param word a word to test
     * @return {@code true} if the word is a dictionary entry
     */
    public boolean isWord(String word);
    
    /**
     * Provides a list of the word lists within the dictionary in which the word
     * was found. 
     * @param word
     * @return a list of tags for word lists the word was found in, or an empty 
     * list if the word was not found
     */
    public List<String> tags( String word );
}
