com.structurizr.inspection.model.SoftwareSystemDocumentationInspection 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

There is a newer version: 3.0.0

Show newest version

package com.structurizr.inspection.model;

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

public class SoftwareSystemDocumentationInspection extends AbstractSoftwareSystemInspection {

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

    @Override
    protected Violation inspect(SoftwareSystem softwareSystem) {
        if (softwareSystem.hasContainers() && softwareSystem.getDocumentation().getSections().isEmpty()) {
            return violation("The " + terminologyFor(softwareSystem).toLowerCase() + " \"" + nameOf(softwareSystem) + "\" has containers, but is missing documentation.");
        }

        return noViolation();
    }

    @Override
    protected String getType() {
        return "model.softwaresystem.documentation";
    }

}