ElementPostponedToNextRoundException.java

/*
 * 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.inject.visitor;

import io.micronaut.core.annotation.Internal;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.inject.ast.Element;

/**
 * Exception is thrown when the visitor is attempted to create a new file but the originated element is postponed to the next round.
 *
 * @author Denis Stepanov
 * @since 4.7
 */
@Internal
public final class ElementPostponedToNextRoundException extends RuntimeException {

    private final Element originatingElement;

    /**
     * @param originatingElement The originating element
     */
    public ElementPostponedToNextRoundException(@NonNull Element originatingElement) {
        super("Original element: " + originatingElement.getName() + " is postponed to the next round!");
        this.originatingElement = originatingElement;
    }

    @NonNull
    public Element getOriginatingElement() {
        return originatingElement;
    }

}