source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube, open source software quality management tool.
   3  * Copyright (C) 2008-2014 SonarSource
   4  * mailto:contact AT sonarsource DOT com
   5  *
   6  * SonarQube is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * SonarQube is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.plugins.core.issue.tracking;
  21
  22 /**
  23  * Equivalence function for a {@link Sequence}.
  24  */
  25 public interface SequenceComparator<S extends Sequence> {
  26
  27   /**
  28    * Compare two items to determine if they are equivalent.
  29    */
  30   boolean equals(S a, int ai, S b, int bi);
  31
  32   /**
  33    * Get a hash value for an item in a sequence.
  34    *
  35    * If two items are equal according to this comparator's
  36    * {@link #equals(Sequence, int, Sequence, int)} method,
  37    * then this hash method must produce the same integer result for both items.
  38    * However not required to have different hash values for different items.
  39    */
  40   int hash(S seq, int i);
  41
  42 }