com.structurizr.inspection.model.MultipleSoftwareSystemsDetailedInspection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of structurizr-inspection Show documentation

Structurizr for Java

The newest version!

package com.structurizr.inspection.model;

import com.structurizr.Workspace;
import com.structurizr.inspection.Inspector;
import com.structurizr.inspection.Violation;
import com.structurizr.model.SoftwareSystem;

public class MultipleSoftwareSystemsDetailedInspection extends AbstractModelInspection {

    public MultipleSoftwareSystemsDetailedInspection(Inspector inspector) {
        super(inspector);
    }

    @Override
    protected Violation inspect(Workspace workspace) {
        int softwareSystemsWithDetails = 0;
        for (SoftwareSystem softwareSystem : workspace.getModel().getSoftwareSystems()) {
            if (softwareSystem.hasContainers() || !softwareSystem.getDocumentation().isEmpty()) {
                softwareSystemsWithDetails++;
            }
        }

        if (softwareSystemsWithDetails > 1) {
            return violation("This workspace describes the internal details of " + softwareSystemsWithDetails + " software systems. It is recommended that a workspace contains the model, views, and documentation for a single software system only.");
        }

        return noViolation();
    }

    @Override
    protected String getType() {
        return "workspace.scope";
    }

}