src/main/java/org/apache/sling/feature/cpconverter/vltpkg/PackagesEventsEmitter.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.sling.feature.cpconverter.vltpkg;

import org.apache.jackrabbit.vault.packaging.PackageId;
import org.apache.jackrabbit.vault.packaging.VaultPackage;
import org.jetbrains.annotations.NotNull;

public interface PackagesEventsEmitter {

    /**
     * Package converter starts
     */
    void start();

    /**
     * Package converter ends
     */
    void end();

    /**
     * Marks the start of the given original package.
     *
     * @param originalPackage the package to be converted.
     */
    void startPackage(@NotNull VaultPackage originalPackage);

    /**
     * Marks the end of the conversion of the package with {@code originalPackageId}.
     * 
     *  @param originalPackageId The id of the original package as passed to {@link #startPackage(VaultPackage)}. 
     * @param convertedPackage the converted package.
     */
    void endPackage(@NotNull PackageId originalPackageId, @NotNull VaultPackage convertedPackage);

    /**
     * Marks the start of the given sub package.
     * 
     * @param path The path of the sub package in the original parent package
     * @param originalPackage the sub package to be converted.
     */
    void startSubPackage(@NotNull String path, @NotNull VaultPackage originalPackage);

    /**
     * Marks the end of the conversion of the sub package with {@code originalPackageId}.
     *
     * @param path The path of the original sub package in the parent package
     * @param originalPackageId The id of the original sub package as passed to {@link #startSubPackage(String, VaultPackage)}.
     * @param convertedPackage the converted package
     */
    void endSubPackage(@NotNull String path, @NotNull PackageId originalPackageId, @NotNull VaultPackage convertedPackage);
}