/* LanguageTool, a natural language style checker 
 * Copyright (C) 2015 Daniel Naber (http://www.danielnaber.de)
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA
 */
package org.languagetool.rules;

import org.languagetool.tools.StringTools;

import java.util.*;

/**
 * Words that can easily be confused - for internal use only.
 * Even though there can be more words in the set, usually there
 * are two, as the factor is specific for this pair of words.
 * @since 3.0
 */
public class ConfusionSet {

  private final Set<ConfusionString> set = new HashSet<>();
  private final long factor;

  public ConfusionSet(long factor, List<ConfusionString> confusionStrings) {
    Objects.requireNonNull(confusionStrings);
    this.factor = factor;
    set.addAll(confusionStrings);
  }

  public ConfusionSet(long factor, String... words) {
    Objects.requireNonNull(words);
    this.factor = factor;
    for (String word : words) {
      set.add(new ConfusionString(word, null));
    }
  }

  /* Alternative must be at least this much more probable to be considered correct. */
  public long getFactor() {
    return factor;
  }

  public Set<ConfusionString> getSet() {
    return Collections.unmodifiableSet(set);
  }

  public Set<ConfusionString> getUppercaseFirstCharSet() {
    Set<ConfusionString> result = new HashSet<>();
    for (ConfusionString s : set) {
      ConfusionString newString = new ConfusionString(StringTools.uppercaseFirstChar(s.getString()), s.getDescription());
      result.add(newString);
    }
    return Collections.unmodifiableSet(result);
  }

  @Override
  public String toString() {
    return set.toString();
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;
    ConfusionSet that = (ConfusionSet) o;
    if (factor != that.factor) return false;
    if (!set.equals(that.set)) return false;
    return true;
  }

  @Override
  public int hashCode() {
    int result = set.hashCode();
    result = 31 * result + (int) (factor ^ (factor >>> 32));
    return result;
  }
  
}

@@ -1288,128 +1288,325 @@
 %0A%0A  
-public ConfusionSet(long factor, List%3CConfusionString%3E confusionStrings) %7B%0A    Objects.requireNonNull(confusionStrings);
+/**%0A   * @param factor the factor that one string must be more probable than the other to be considered a correction, must be %3E= 1%0A   */%0A  public ConfusionSet(long factor, List%3CConfusionString%3E confusionStrings) %7B%0A    if (factor %3C 1) %7B%0A      throw new IllegalArgumentException(%22factor must be %3E= 1: %22 + factor);%0A    %7D
 %0A   
@@ -1643,16 +1643,39 @@
 .addAll(
+Objects.requireNonNull(
 confusio
@@ -1683,16 +1683,17 @@
 Strings)
+)
 ;%0A  %7D%0A%0A 
@@ -1697,59 +1697,302 @@
 %0A%0A  
-public ConfusionSet(long factor, String... words) %7B
+/**%0A   * @param factor the factor that one string must be more probable than the other to be considered a correction, must be %3E= 1%0A   */%0A  public ConfusionSet(long factor, String... words) %7B%0A    if (factor %3C 1) %7B%0A      throw new IllegalArgumentException(%22factor must be %3E= 1: %22 + factor);%0A    %7D
 %0A   
@@ -2959,20 +2959,21 @@
 sionSet 
+o
 th
-at
+er
  = (Conf
@@ -3003,20 +3003,21 @@
 ctor != 
+o
 th
-at
+er
 .factor)
@@ -3051,20 +3051,21 @@
 .equals(
+o
 th
-at
+er
 .set)) r

add javadoc; check factor argument