org.gradle.api.internal.tasks.execution.DescribingAndSpec 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.
The newest version!
/*
 * Copyright 2021 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.internal.tasks.execution;

import groovy.lang.Closure;
import org.gradle.api.specs.AndSpec;
import org.gradle.api.specs.CompositeSpec;
import org.gradle.api.specs.Spec;
import org.gradle.api.specs.internal.ClosureSpec;
import org.gradle.internal.Cast;

import javax.annotation.Nullable;

/**
 * A {@link CompositeSpec} that requires all component specs to provide a description.
 * The aggregation is based on an {@link AndSpec}.
 *
 * @param  The target type for this Spec
 */
public class DescribingAndSpec extends CompositeSpec {
    private static final DescribingAndSpec EMPTY = new DescribingAndSpec<>();
    private final AndSpec specHolder;

    private DescribingAndSpec(AndSpec specHolder) {
        super(specHolder.getSpecs().toArray(Cast.uncheckedCast(new Spec[0])));
        this.specHolder = specHolder;
    }

    public DescribingAndSpec() {
        this(AndSpec.empty());
    }

    public DescribingAndSpec(Spec spec, String description) {
        this(new AndSpec<>(new SelfDescribingSpec<>(spec, description)));
    }

    @Override
    public boolean isSatisfiedBy(T element) {
        return specHolder.isSatisfiedBy(element);
    }

    @Nullable
    public SelfDescribingSpec findUnsatisfiedSpec(T element) {
        return Cast.uncheckedCast(specHolder.findUnsatisfiedSpec(element));
    }

    public DescribingAndSpec and(Spec spec, String description) {
        return new DescribingAndSpec<>(specHolder.and(new SelfDescribingSpec<>(spec, description)));
    }

    @SuppressWarnings("rawtypes")
    public DescribingAndSpec and(Closure closure, String description) {
        return and(new ClosureSpec<>(closure), description);
    }

    public static  DescribingAndSpec empty() {
        return Cast.uncheckedNonnullCast(EMPTY);
    }
}