testdescriptionmodifier.java

来自「cqME :java framework for TCK test.」· Java 代码 · 共 111 行

/*
 * $Id$
 *
 * Copyright 1996-2007 Sun Microsystems, Inc. All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version
 * 2 only, as published by the Free Software Foundation.
 *
 * This program 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
 * General Public License version 2 for more details (a copy is
 * included at /legal/license.txt).
 *
 * You should have received a copy of the GNU General Public License
 * version 2 along with this work; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
 * Clara, CA 95054 or visit www.sun.com if you need additional
 * information or have any questions.
 *
 */

package com.sun.tck.j2me.javatest;

import java.util.Set;

import com.sun.javatest.TestDescription;

/**
 * Objects of this interface encapsulate <code>TestDescription</code>
 * modification strategy which is used by {@link ModifyingTestFinder}.
 */
public interface TestDescriptionModifier {
    /**
     * The main method that performs actual test description modification.
     * <p>
     * Returns a Set with original description if it is considered as not
     * modifiable.
     *
     * @param td
     *                The original test description.
     * @return The Set of newly created test descriptions.
     * @see #isModifiable(TestDescription)
     */
    Set modify(TestDescription td);

    /**
     * Returns <code>true</code> if and only if the given test description is
     * going to be modified by the modifier.
     *
     * @param td
     *                The original test description.
     * @return <code>true</code> if the modifier will
     */
    boolean isModifiable(TestDescription td);

    /**
     * Returns <code>true</code> if and only if the given test description has
     * already been modified by this modifier.
     *
     * @param td
     *                The test description.
     * @return <code>true</code> if the given description has been already
     *            modified by this modifier.
     */
    boolean isModifiedTest(TestDescription td);

    /**
     * Returns <code>true</code> if and only if the given test name belongs to
     * the test description that has already been modified by this modifier.
     * <p>
     * Test name can be calculated from the description by using
     * <code>TestDescription.getRootRelativeURL()</code> method.
     *
     * @param testName
     *                The test name.
     * @return <code>true</code> if the given test name belongs to the
     *            description that has been already modified by this modifier.
     */
    boolean isModifiedTest(String testName);

    /**
     * Returns an original description for given modified one.
     * <p>
     * Returns <code>null</code> if the provided description has not been
     * modified by this modifier.
     *
     * @param td
     *                Modified test description.
     * @return Original test description, or <code>null</code>.
     */
    TestDescription getOriginalDescription(TestDescription td);

    /**
     * Returns an original test name for given name of modified test.
     * <p>
     * Returns <code>null</code> if no tests with given name have been
     * modified by this modifier.
     *
     * @param modifiedTestName
     *                The name of modified test.
     * @return Original test description, or <code>null</code>.
     */
    String getOriginalTestName(String modifiedTestName);
}