Package org.brapi.schematools.core.openapi.comparator.options

Class OpenAPIComparatorOptions

java.lang.Object

org.brapi.schematools.core.openapi.comparator.options.OpenAPIComparatorOptions

All Implemented Interfaces:

Options, Validatable

public class OpenAPIComparatorOptions
extends Object
implements Options

Options for the OpenAPIComparator.

Constructor Summary

Constructors

Constructor	Description
OpenAPIComparatorOptions()

Method Summary

Modifier and Type	Method	Description
boolean	isIgnoringDeprecatedEndpoints()
static OpenAPIComparatorOptions	load()	Load the default options
static OpenAPIComparatorOptions	load(InputStream inputStream)	Load the options from an option input stream in YAML or JSON.
static OpenAPIComparatorOptions	load(Path optionsFile)	Load the options from an option file in YAML or Json.
OpenAPIComparatorOptions	override(OpenAPIComparatorOptions overrideOptions)	Overrides the values in this Options Object from the provided Options Object if they are non-null
Validation	validate()	Checks if the Validatable object is valid, return a list of errors if it is not valid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenAPIComparatorOptions

public OpenAPIComparatorOptions()

Method Details

load

public static OpenAPIComparatorOptions load()

Load the default options

Returns:

The default options

load

public static OpenAPIComparatorOptions load(Path optionsFile)
                                     throws IOException

Load the options from an option file in YAML or Json. The options file may have missing (defined) values, in these cases the default values are loaded. See load()

Parameters:

optionsFile - The path to the options file in YAML or Json.

Returns:

The options loaded from the YAML or Json file.

Throws:

IOException - if the option file cannot be found or is incorrectly formatted.

load

public static OpenAPIComparatorOptions load(InputStream inputStream)
                                     throws IOException

Load the options from an option input stream in YAML or JSON. The options file may have missing (defined) values, in these cases the default values are loaded. See load()

Parameters:

inputStream - The input stream in YAML or JSON.

Returns:

The options loaded from input stream.

Throws:

IOException - if the input stream is not valid or the content is incorrectly formatted.

override

public OpenAPIComparatorOptions override(OpenAPIComparatorOptions overrideOptions)

Overrides the values in this Options Object from the provided Options Object if they are non-null

Parameters:

overrideOptions - the Options which will be used to override this Options Object

Returns:

this object for method chaining

validate

public Validation validate()

Description copied from interface: Validatable

Checks if the Validatable object is valid, return a list of errors if it is not valid

Specified by:

validate in interface Validatable

Returns:

a Validation object than can be used queried to find if the object is valid and any errors if it is not valid

isIgnoringDeprecatedEndpoints

public boolean isIgnoringDeprecatedEndpoints()