org.gradle.api.flow.FlowActionSpec Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gradle-api Show documentation

Gradle 6.9.1 API redistribution.

There is a newer version: 8.11.1

/*
 * Copyright 2022 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.api.flow;

import org.gradle.api.Action;
import org.gradle.api.Incubating;

/**
 * Allows configuring the parameters for a {@link FlowAction dataflow action}.
 *
 * @param  the parameters defined by the configured {@link FlowAction dataflow action} type.
 * @since 8.1
 */
@Incubating
public interface FlowActionSpec {

    /**
     * Returns the parameters defined by the configured {@link FlowAction dataflow action}.
     *
     * @return mutable parameters object, never null.
     * @since 8.1
     */
    P getParameters();

    /**
     * Configures the {@link P parameters} for the {@link FlowAction flow action}.
     *
     * @since 8.7
     */
    void parameters(Action configureAction);
}