com.tngtech.archunit.lang.AbstractClassesTransformer 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.lang;

import com.tngtech.archunit.PublicAPI;
import com.tngtech.archunit.base.DescribedIterable;
import com.tngtech.archunit.base.DescribedPredicate;
import com.tngtech.archunit.core.domain.JavaClasses;

import static com.tngtech.archunit.PublicAPI.Usage.INHERITANCE;
import static java.util.stream.Collectors.toList;
import static java.util.stream.StreamSupport.stream;

/**
 * Default base implementation of {@link ClassesTransformer}, where only {@link #doTransform(JavaClasses)}
 * has to be implemented, while description and filtering via {@link #that(DescribedPredicate)} are provided.
 */
@PublicAPI(usage = INHERITANCE)
public abstract class AbstractClassesTransformer implements ClassesTransformer {
    private final String description;

    protected AbstractClassesTransformer(String description) {
        this.description = description;
    }

    @Override
    public final DescribedIterable transform(JavaClasses collection) {
        return DescribedIterable.From.iterable(doTransform(collection), description);
    }

    public abstract Iterable doTransform(JavaClasses collection);

    @Override
    public final ClassesTransformer that(DescribedPredicate predicate) {
        return new AbstractClassesTransformer(description + " that " + predicate.getDescription()) {
            @Override
            public Iterable doTransform(JavaClasses collection) {
                Iterable transformed = AbstractClassesTransformer.this.doTransform(collection);
                return stream(transformed.spliterator(), false).filter(predicate).collect(toList());
            }
        };
    }

    @Override
    public final String getDescription() {
        return description;
    }

    @Override
    public final ClassesTransformer as(String description) {
        return new AbstractClassesTransformer(description) {
            @Override
            public Iterable doTransform(JavaClasses collection) {
                return AbstractClassesTransformer.this.doTransform(collection);
            }
        };
    }

    @Override
    public String toString() {
        return ClassesTransformer.class.getSimpleName() + "{" + getDescription() + "}";
    }
}