/*
 * 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
 *
 *  https://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.
 *
 * Other licenses:
 * -----------------------------------------------------------------------------
 * Commercial licenses for this work are available. These replace the above
 * Apache-2.0 license and offer limited warranties, support, maintenance, and
 * commercial database integrations.
 *
 * For more information, please visit: https://www.jooq.org/legal/licensing
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.ApiStatus.Experimental;

/**
 * A set of files that are in a specific order.
 * <p>
 * This type will help make sure that duplicate occurrences of the same file
 * (e.g. edits) are streamlined.
 * <p>
 * This is EXPERIMENTAL functionality and subject to change in future jOOQ
 * versions.
 */
@Experimental
public interface Files extends Iterable<File> {

    /**
     * The from version from which this migration is done.
     * <p>
     * This is EXPERIMENTAL functionality and subject to change in future jOOQ
     * versions.
     */
    @NotNull
    @Experimental
    Version from();

    /**
     * The last {@link ContentType#SNAPSHOT} version that is being migrated
     * from, or <code>null</code> if there's no snapshot.
     * <p>
     * This is EXPERIMENTAL functionality and subject to change in future jOOQ
     * versions.
     * <p>
     * This API is part of a commercial only feature. To use this feature,
     * please use the jOOQ Professional Edition or the jOOQ Enterprise Edition.
     */
    @Nullable
    @Experimental
    Version fromSnapshot();

    /**
     * The to version to which this migration is done.
     * <p>
     * This is EXPERIMENTAL functionality and subject to change in future jOOQ
     * versions.
     */
    @NotNull
    @Experimental
    Version to();
}
