org.passay.dictionary.DictionaryBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of passay Show documentation

Library for checking that a password complies with a custom set of rules

There is a newer version: 1.6.6

/* See LICENSE for licensing and NOTICE for copyright. */
package org.passay.dictionary;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.IOException;
import java.io.Reader;
import java.util.ArrayList;
import java.util.List;
import org.passay.dictionary.sort.ArraySorter;
import org.passay.dictionary.sort.ArraysSort;

/**
 * Builder for common dictionary usage. Creates a {@link WordListDictionary} backed by an {@link ArrayWordList} from one
 * or more files containing a list of words, one per line.
 *
 * @author  Middleware Services
 */
public class DictionaryBuilder
{

  /** Singleton array sorter, must be thread safe. */
  private static final ArraySorter SORTER = new ArraysSort();

  /** List of word list files. */
  private final List sources = new ArrayList<>();

  /** Dictionary case sensitivity flag. */
  private boolean caseSensitive;


  /**
   * Adds a word list to the dictionary to be built.
   *
   * @param  path  Path to word list, one word per line.
   *
   * @return  This builder.
   */
  public DictionaryBuilder addFile(final String path)
  {
    try {
      return addReader(new FileReader(new File(path)));
    } catch (FileNotFoundException e) {
      throw new IllegalArgumentException(path + " does not exist", e);
    }
  }

  /**
   * Adds a word list to the dictionary to be built.
   *
   * @param  reader  Reader which returns a word list, one word per line.
   *
   * @return  This builder.
   */
  public DictionaryBuilder addReader(final Reader reader)
  {
    sources.add(reader);
    return this;
  }

  /**
   * Sets the case sensitivity flag on the dictionary to be built. Dictionaries are built case insensitive by
   * default.
   *
   * @param  flag  True for case sensitive, false otherwise.
   *
   * @return  This builder.
   */
  public DictionaryBuilder setCaseSensitive(final boolean flag)
  {
    caseSensitive = flag;
    return this;
  }


  /**
   * Builds a dictionary from the configured properties.
   *
   * @return  New {@link WordListDictionary} instance.
   */
  public Dictionary build()
  {
    try {
      final List wordList = new ArrayList<>();
      for (Reader reader : sources) {
        WordLists.readWordList(reader, wordList);
      }

      final String[] words = new String[wordList.size()];
      wordList.toArray(words);
      return new WordListDictionary(new ArrayWordList(words, caseSensitive, SORTER));
    } catch (IOException e) {
      throw new RuntimeException("IO error building dictionary", e);
    }
  }
}