jpa/org.eclipse.persistence.jpa.jpql/src/main/java/org/eclipse/persistence/jpa/jpql/tools/RefactoringDelta.java

/*
 * Copyright (c) 2012, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//     Oracle - initial API and implementation
//
package org.eclipse.persistence.jpa.jpql.tools;

/**
 * A refactoring delta contains an ordered collection of {@link TextEdit}. The order is based on the
 * offset of those {@link TextEdit} objects: from the biggest offset to the smallest offset. This
 * will allow the invoker to perform the refactoring by replacing the old values by the new values
 * by following that order.
 * <p>
 * Provisional API: This interface is part of an interim API that is still under development and
 * expected to change significantly before reaching stability. It is available at this early stage
 * to solicit feedback from pioneering adopters on the understanding that any code that uses this
 * API will almost certainly be broken (repeatedly) as the API evolves.
 *
 * @see BasicRefactoringTool
 *
 * @version 2.5
 * @since 2.4
 * @author Pascal Filion
 */
public interface RefactoringDelta {

    /**
     * Applies the changes to the JPQL query and returns the refactoring operations. The list of {@link
     * TextEdit} will be cleared.
     */
    String applyChanges();

    /**
     * Determines whether at least one {@link TextEdit} was added.
     *
     * @return <code>true</code> if there is at least one {@link TextEdit}; <code>false</code> otherwise
     */
    boolean hasTextEdits();

    /**
     * Returns the number of {@link TextEdit} objects that have been added.
     *
     * @return The count of {@link TextEdit} objects
     */
    int size();

    /**
     * Returns the collection of {@link TextEdit} objects that have been added during one or several
     * refactoring operations. The collection has been ordered where the {@link TextEdit}'s offset
     * are in reverse order, i.e. from the biggest to the smallest values.
     *
     * @return The ordered collection of {@link TextEdit} objects
     */
    Iterable<TextEdit> textEdits();
}