common/src/test/core/org/apache/hadoop/cli/util/ComparatorBase.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

package org.apache.hadoop.cli.util;

/**
 *
 * Comparator interface. To define a new comparator, implement the compare
 * method
 */
public abstract class ComparatorBase {
  public ComparatorBase() {
    
  }
  
  /**
   * Compare method for the comparator class.
   * @param actual output. can be null
   * @param expected output. can be null
   * @return true if expected output compares with the actual output, else
   *         return false. If actual or expected is null, return false
   */
  public abstract boolean compare(String actual, String expected);
}