OrderedDatabaseTestCase.java

/*
 * Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
 * Copyright [2016-2017] EMBL-European Bioinformatics Institute
 * 
 * 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.
 */

package org.ensembl.healthcheck.testcase;

import org.ensembl.healthcheck.DatabaseRegistryEntry;

/**
 * Subclass of EnsTestCase for tests that apply to an <em>ordered set</em> of databases. Such
 * tests should subclass <em>this</em> class and implement the <code>run</code> method.
 */
public abstract class OrderedDatabaseTestCase extends EnsTestCase {

    /**
     * This method must be overridden by subclasses.
     * 
     * @param dbre
     *          The databases to check, in the order they were specified on the command line.
     * @return true if the test passed.
     */
    public abstract boolean run(DatabaseRegistryEntry[] dbre);

}