com.day.cq.compat.codeupgrade.annotations.MigrationType Maven / Gradle / Ivy

/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2016 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/
package com.day.cq.compat.codeupgrade.annotations;

import com.day.cq.compat.codeupgrade.CodeUpgradeTask;
import org.osgi.annotation.versioning.ProviderType;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * The {@code MigrationType} declares if a {@code CodeUpgradeTask} may run delayed or must be immediately and synchronously
 * executed during upgrade startup. {@code CodeUpgradeTask}s annotated with this annotation are by default running delayed
 * mandating application logic to work with the old content structure until a delayed migration is triggered.
 */
@ProviderType
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
public @interface MigrationType {
    CodeUpgradeTask.MigrationType type() default CodeUpgradeTask.MigrationType.DELAYED;
}