io.kemtoa.swagger.compat.rules.Rule Maven / Gradle / Ivy

Go to download
package io.kemtoa.swagger.compat.rules;

import java.util.ArrayList;
import java.util.List;

import io.kemtoa.swagger.compat.walker.Location;
import io.kemtoa.swagger.compat.walker.SwaggerDiffVisitor;

/**
 * Base class for the backwards compatibility check rules
 *
 * Two Swagger specifications are deemed compatible when a set
 * of rules are verified when comparing the documents.
 */
public abstract class Rule implements SwaggerDiffVisitor {
    protected Location location;
    private final List errors = new ArrayList<>();

    @Override
    public void setLocation(Location location) {
        this.location = location;
    }

    public void addError(String message) {
        errors.add(location.getFullLocation() + " : " + message);
    }

    public List getErrors() {
        return errors;
    }
}