CaseComparison.java

/**
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 *
 * Copyright 2012-2016 the original author or authors.
 */
package org.assertj.db.type.lettercase;

import java.util.Comparator;

/**
 * Comparison on {@link java.lang.String} which consider the case.
 * @author Régis Pouiller
 * @since 1.1.0
 */
public interface CaseComparison extends Comparator<String> {

  /**
   * Returns the name of the comparison.
   * @return The name of the comparison.
   */
  String getComparisonName();

  /**
   * Returns if {@code value1} is equal to {@code value2}.
   * @param value1 The first value to compare.
   * @param value2 The second value to compare.
   * @return If the two values are equal.
   */
  boolean isEqual(String value1, String value2);
}