io.micronaut.aop.InterceptPhase Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-aop Show documentation

Core components supporting the Micronaut Framework

There is a newer version: 4.6.5

/*
 * Copyright 2017-2020 original authors
 *
 * 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.
 */
package io.micronaut.aop;

/**
 * {@link Interceptor} classes implement the {@link io.micronaut.core.order.Ordered} interface
 * in order to control the order of execution when multiple interceptors are present.
 *
 * This class provides a set of common constants for typical phases used by interceptors thus making it easier to position an interceptor in the correct phase.
 *
 * @author Graeme Rocher
 * @since 1.0
 */
public enum InterceptPhase {
    /**
     * Validation phase of execution.
     */
    VALIDATE(-120),
    /**
     * Caching phase of execution.
     */
    CACHE(-100),
    /**
     * Trace phase of execution.
     */
    TRACE(-80),
    /**
     * Retry phase of execution.
     */
    RETRY(-60),
    /**
     * Async phase of execution.
     */
    ASYNC(-40),
    /**
     * Transaction phase of execution.
     */
    TRANSACTION(-20);

    private final int position;

    /**
     * Constructor.
     *
     * @param position The order of position
     */
    InterceptPhase(int position) {
        this.position = position;
    }

    /**
     * @return The position
     */
    public int getPosition() {
        return position;
    }
}