com.structurizr.inspection.model.ElementDescriptionInspection 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.Element;
import com.structurizr.util.StringUtils;

abstract class ElementDescriptionInspection extends AbstractElementInspection {

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

    @Override
    protected Violation inspect(Element element) {
        if (StringUtils.isNullOrEmpty(element.getDescription())) {
            return violation("The " + terminologyFor(element).toLowerCase() + " \"" + nameOf(element) + "\" is missing a description.");
        }

        return noViolation();
    }

}