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

Class MarkdownRenderOptions

java.lang.Object

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

All Implemented Interfaces:

Options, Validatable

public class MarkdownRenderOptions
extends Object
implements Options

Markdown Render Options for the OpenAPIComparator..

Constructor Summary

Constructors

Constructor	Description
MarkdownRenderOptions()

Method Summary

Modifier and Type	Method	Description
boolean	isShowingChangedMetadata()	Determines if the Markdown Render should show changes in the metadata such as summary and description
void	override(MarkdownRenderOptions 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

MarkdownRenderOptions

public MarkdownRenderOptions()

Method Details

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

override

public void override(MarkdownRenderOptions 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

isShowingChangedMetadata

public boolean isShowingChangedMetadata()

Determines if the Markdown Render should show changes in the metadata such as summary and description

Returns:

true if the Markdown Render should show changes in the metadata such as summary and description, false otherwise