/*
 * Copyright 2017 the original author or 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
 *
 *      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 org.gradle.normalization.internal;

import org.gradle.internal.service.scopes.Scope;
import org.gradle.internal.service.scopes.ServiceScope;
import org.gradle.normalization.InputNormalizationHandler;
import org.jspecify.annotations.Nullable;

@ServiceScope(Scope.Project.class)
public interface InputNormalizationHandlerInternal extends InputNormalizationHandler {
    @Override
    RuntimeClasspathNormalizationInternal getRuntimeClasspath();

    /**
     * Returns the configuration of input normalization in a configuration-cache friendly form.
     * Input normalization cannot be further configured after this call.
     *
     * @return the configuration of input normalization or {@code null} if there is no user-defined state.
     */
    @Nullable
    CachedState computeCachedState();

    /**
     * Configures input normalization from cached state data.
     */
    void configureFromCachedState(CachedState state);

    /**
     * The opaque representation of the input normalization state, intended to be serialized in the configuration cache.
     */
    interface CachedState {
        /**
         * @return the configuration of runtime classpath normalization
         */
        RuntimeClasspathNormalizationInternal.CachedState getRuntimeClasspathState();
    }
}
