com.github.dylon.liblevenshtein.levenshtein.factory.ICandidateCollectionBuilder Maven / Gradle / Ivy

Go to download

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

A library for spelling-correction based on Levenshtein Automata.

There is a newer version: 2.2.2

package com.github.dylon.liblevenshtein.levenshtein.factory;

import com.github.dylon.liblevenshtein.levenshtein.ICandidateCollection;

/**
 * Builds collections that hold spelling candidates for some query term.
 * @param  Kind of spelling candidates held by the collections.
 * @author Dylon Edwards
 * @since 2.1.0
 */
public interface ICandidateCollectionBuilder {

  /**
   * Specifies the maximum number of spelling candidates to hold in a
   * collection.
   * @param maxCandidates maximum number of spelling candidates to hold in a
   * collection
   * @return This {@link ICandidateCollectionBuilder} for fluent setters.
   */
  ICandidateCollectionBuilder maxCandidates(int maxCandidates);

  /**
   * Builds a new collection of spelling candidate.
   * @return New instance of {@link ICandidateCollectionBuilder}.
   */
  ICandidateCollection build();
}