Candidate.java

package com.github.liblevenshtein.transducer;

import java.io.Serializable;

import lombok.Value;

/**
 * POJO returned when the distances are requested of the candidate terms from
 * the query term, that are returned from the transducer.
 * @author Dylon Edwards
 * @since 2.1.0
 */
@Value
public class Candidate implements Serializable {

  private static final long serialVersionUID = 1L;

  /**
   * Candidate term from the dictionary automaton.
   * @return Candidate term from the dictionary automaton.
   */
  private final String term;

  /**
   * Distance between the candidate term and the query term.
   * @return Distance between the candidate term and the query term.
   */
  private final int distance;
}