io.openapiprocessor.jsonschema.ouput.OutputUnit Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of json-schema-validator Show documentation

OpenAPI Parser JSON-Schema Validator

There is a newer version: 2024.4

Show newest version

/*
 * Copyright 2023 https://github.com/openapi-processor/openapi-parser
 * PDX-License-Identifier: Apache-2.0
 */

package io.openapiprocessor.jsonschema.ouput;

import org.checkerframework.checker.nullness.qual.Nullable;

import java.util.Collection;

public interface OutputUnit {

    /**
     * validation result
     */
    boolean isValid ();

    /**
     * relative location of the validating keyword
     */
    String getKeywordLocation ();

    /**
     * The location of the validated JSON value within the instance
     */
    String getInstanceLocation ();

    /**
     * The absolute, dereferenced location of the validating keyword
     */
    String getAbsoluteKeywordLocation ();

    @Nullable String getError ();

    @Nullable Object getAnnotation ();

    /**
     * errors or annotation produced by a failed validation
     */
    @Nullable Collection getErrors ();

    /**
     * errors or annotation produced by a successful validation
     */
    @Nullable Collection getAnnotations ();
}