com.tngtech.archunit.core.domain.PackageMatchers 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-2024 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.core.domain;

import java.util.Collection;
import java.util.Set;

import com.google.common.collect.ImmutableSet;
import com.tngtech.archunit.PublicAPI;
import com.tngtech.archunit.base.DescribedPredicate;

import static com.tngtech.archunit.PublicAPI.Usage.ACCESS;
import static com.tngtech.archunit.core.domain.Formatters.joinSingleQuoted;

@PublicAPI(usage = ACCESS)
public final class PackageMatchers extends DescribedPredicate {
    private final Set packageMatchers;

    private PackageMatchers(Set packageIdentifiers) {
        super("matches any of [%s]", joinSingleQuoted(packageIdentifiers));
        ImmutableSet.Builder matchers = ImmutableSet.builder();
        for (String identifier : packageIdentifiers) {
            matchers.add(PackageMatcher.of(identifier));
        }
        packageMatchers = matchers.build();
    }

    @PublicAPI(usage = ACCESS)
    public static PackageMatchers of(String... packageIdentifiers) {
        return of(ImmutableSet.copyOf(packageIdentifiers));
    }

    @PublicAPI(usage = ACCESS)
    public static PackageMatchers of(Collection packageIdentifiers) {
        return new PackageMatchers(ImmutableSet.copyOf(packageIdentifiers));
    }

    @Override
    @PublicAPI(usage = ACCESS)
    public boolean test(String aPackage) {
        boolean matches = false;
        for (PackageMatcher matcher : packageMatchers) {
            matches = matches || matcher.matches(aPackage);
        }
        return matches;
    }
}