001package daikon.chicory;
002
003import org.checkerframework.checker.nullness.qual.Nullable;
004
005/**
006 * The {@link #getComparability} method calculates a comparability value.
007 *
008 * <p>This interface permits both {@code DCRuntime} and {@code DeclWriter} to call {@code
009 * DeclWriter.printDecl}; otherwise, they would need to duplicate code.
010 */
011public interface ComparabilityProvider {
012  /**
013   * Calculate a comparability value.
014   *
015   * @param dv variable to calculate comparability for
016   * @param compare_ppt corresponding ppt from DynComp input; or null if none
017   * @return comparability value
018   */
019  public String getComparability(DaikonVariableInfo dv, DeclReader.@Nullable DeclPpt compare_ppt);
020}