com.networknt.oas.validator.ValidationResults Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openapi-parser Show documentation

A light-weight, fast OpenAPI 3.0 parser and validator

There is a newer version: 2.1.36

/*******************************************************************************
 *  Copyright (c) 2017 ModelSolv, Inc. and others.
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  which accompanies this distribution, and is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *
 *  Contributors:
 *     ModelSolv, Inc. - initial API and implementation and/or initial documentation
 *******************************************************************************/
package com.networknt.oas.validator;

import com.networknt.jsonoverlay.Overlay;
import com.networknt.jsonoverlay.PositionInfo;

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

import static com.networknt.oas.validator.ValidationResults.Severity.*;

public class ValidationResults {

	public enum Severity {
		NONE, INFO, WARNING, ERROR;

		public static final Severity MAX_SEVERITY = ERROR;

		public boolean lt(Severity other) {
			return this.compareTo(other) < 0;
		}

		public boolean le(Severity other) {
			return this.compareTo(other) <= 0;
		}

		public boolean gt(Severity other) {
			return this.compareTo(other) > 0;
		}

		public boolean ge(Severity other) {
			return this.compareTo(other) >= 0;
		}
	};

	private List items = new ArrayList<>();

	public  void addInfo(String msg, Overlay context) {
		items.add(new ValidationItem(INFO, msg, context));
	}

	public void addWarning(String msg, Overlay context) {
		items.add(new ValidationItem(WARNING, msg, context));
	}

	public void addError(String msg, Overlay context) {
		items.add(new ValidationItem(ERROR, msg, context));
	}

	public void add(ValidationResults results) {
		items.addAll(results.getItems());
	}

	public Collection getItems() {
		return items;
	}

	public Severity getSeverity() {
		Severity severity = NONE;
		for (ValidationItem item : items) {
			if (item.getSeverity().gt(severity)) {
				severity = item.getSeverity();
				if (severity == MAX_SEVERITY) {
					break;
				}
			}
		}
		return severity;
	}

	public static class ValidationItem {
		private Severity severity;
		private String msg;
		private PositionInfo positionInfo;

		public ValidationItem(Severity severity, String msg, Overlay context) {
			this.severity = severity;
			this.msg = msg;
			this.positionInfo = context != null ? context.getPositionInfo().orElse(null) : null;
		}

		public Severity getSeverity() {
			return severity;
		}

		public String getMsg() {
			return msg;
		}

		public PositionInfo getPositionInfo() {
			return positionInfo;
		}

		@Override
		public String toString() {
			String posString = positionInfo != null ? positionInfo.toString(true) + ": " : "";
			return posString + msg;
		}
	}
}