io.github.lxgaming.common.inject.ServiceScope Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of common-inject Show documentation

Lightweight* dependency injection framework for Java

There is a newer version: 1.3.0

/*
 * Copyright 2022 Alex Thomson
 *
 * 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
 *
 * 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 io.github.lxgaming.common.inject;

import org.jetbrains.annotations.NotNull;

/**
 * The {@link AutoCloseable#close()} method ends the scope lifetime. Once close is called,
 * any {@link ServiceLifetime#SCOPED} services that have been resolved from the {@link ServiceProvider} will be closed.
 */
public class ServiceScope implements AutoCloseable {
    
    protected final ServiceProviderImpl serviceProvider;
    
    protected ServiceScope(@NotNull ServiceProviderImpl serviceProvider) {
        this.serviceProvider = serviceProvider;
    }
    
    @Override
    public void close() throws Exception {
        serviceProvider.close();
    }
    
    /**
     * The {@link ServiceProvider} used to resolve services from the scope.
     *
     * @return the {@link ServiceProvider}
     */
    public @NotNull ServiceProvider getServiceProvider() {
        return serviceProvider;
    }
}