io.micronaut.inject.DisposableBeanDefinition Maven / Gradle / Ivy
/*
* 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;
import io.micronaut.context.BeanContext;
import io.micronaut.context.BeanResolutionContext;
import io.micronaut.context.DefaultBeanResolutionContext;
import io.micronaut.core.annotation.Internal;
/**
* A bean definition that provides disposing hooks normally in the form of {@link jakarta.annotation.PreDestroy}
* annotated methods.
*
* @param The bean definition type
* @author Graeme Rocher
* @see jakarta.annotation.PreDestroy
* @since 1.0
*/
@Internal
public interface DisposableBeanDefinition extends BeanDefinition {
/**
* Disposes of the bean definition by executing all {@link jakarta.annotation.PreDestroy} hooks.
*
* @param context The bean context
* @param bean The bean
* @return The bean instance
*/
default T dispose(BeanContext context, T bean) {
try (DefaultBeanResolutionContext rc = new DefaultBeanResolutionContext(context, this)) {
return dispose(rc, context, bean);
}
}
/**
* Disposes of the bean definition by executing all {@link jakarta.annotation.PreDestroy} hooks.
*
* @param resolutionContext The bean resolution context
* @param context The bean context
* @param bean The bean
* @return The bean instance
*/
T dispose(BeanResolutionContext resolutionContext, BeanContext context, T bean);
}