com.tngtech.archunit.lang.conditions.AnyDependencyCondition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of archunit Show documentation

A Java architecture test library, to specify and assert architecture rules in plain Java - Module 'archunit'

There is a newer version: 1.3.0

/*
 * Copyright 2014-2021 TNG Technology Consulting GmbH
 *
 * 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 com.tngtech.archunit.lang.conditions;

import java.util.Collection;
import java.util.HashSet;

import com.tngtech.archunit.PublicAPI;
import com.tngtech.archunit.base.DescribedPredicate;
import com.tngtech.archunit.base.Function;
import com.tngtech.archunit.core.domain.Dependency;
import com.tngtech.archunit.core.domain.JavaClass;

import static com.google.common.base.Preconditions.checkNotNull;
import static com.tngtech.archunit.PublicAPI.Usage.ACCESS;

@PublicAPI(usage = ACCESS)
public final class AnyDependencyCondition extends AnyAttributeMatchesCondition {
    private final DescribedPredicate conditionPredicate;
    private final Function> javaClassToRelevantDependencies;
    private final DescribedPredicate ignorePredicate;

    AnyDependencyCondition(
            String description,
            final DescribedPredicate predicate,
            Function> javaClassToRelevantDependencies) {

        this(description, predicate, javaClassToRelevantDependencies, DescribedPredicate.alwaysFalse());
    }

    private AnyDependencyCondition(
            String description,
            final DescribedPredicate conditionPredicate,
            Function> javaClassToRelevantDependencies,
            DescribedPredicate ignorePredicate) {

        super(description, new DependencyCondition(conditionPredicate));
        this.conditionPredicate = checkNotNull(conditionPredicate);
        this.javaClassToRelevantDependencies = checkNotNull(javaClassToRelevantDependencies);
        this.ignorePredicate = checkNotNull(ignorePredicate);
    }

    @PublicAPI(usage = ACCESS)
    public AnyDependencyCondition ignoreDependency(DescribedPredicate ignorePredicate) {
        return new AnyDependencyCondition(getDescription(),
                conditionPredicate,
                javaClassToRelevantDependencies,
                this.ignorePredicate.or(ignorePredicate));
    }

    @Override
    @PublicAPI(usage = ACCESS)
    public AnyDependencyCondition as(String description, Object... args) {
        return new AnyDependencyCondition(
                String.format(description, args),
                conditionPredicate,
                javaClassToRelevantDependencies,
                ignorePredicate);
    }

    @Override
    Collection relevantAttributes(JavaClass javaClass) {
        Collection result = new HashSet<>();
        for (Dependency dependency : javaClassToRelevantDependencies.apply(javaClass)) {
            if (!ignorePredicate.apply(dependency)) {
                result.add(dependency);
            }
        }
        return result;
    }
}