Package com.github.victools.jsonschema.generator

Class OptionPreset

java.lang.Object

com.github.victools.jsonschema.generator.OptionPreset

public class OptionPreset
extends Object

Selection of Option entries to be enabled by default, which can be overridden via SchemaGeneratorConfigBuilder.with(Option, Option...)/SchemaGeneratorConfigBuilder.without(Option, Option...).

Field Summary

Fields

Modifier and Type	Field	Description
static final OptionPreset	FULL_DOCUMENTATION	Preset: including private/package/protected/public fields and all public methods.
static final OptionPreset	JAVA_OBJECT	Preset: including public fields and all public methods.
static final OptionPreset	PLAIN_JSON	Preset: including private/package/protected/public fields and no methods.

Constructor Summary

Constructors

Constructor	Description
OptionPreset(Option... enabledByDefault)	Constructor: defining the fixed list of options to be enabled by default.

Method Summary

Modifier and Type	Method	Description
boolean	isOptionEnabledByDefault(Option setting)	Indicate whether the given option should be enabled, if it was not specifically included/excluded in the SchemaGeneratorConfigBuilder.

Methods inherited from class java.lang.Object

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

Field Details

FULL_DOCUMENTATION

public static final OptionPreset FULL_DOCUMENTATION

Preset: including private/package/protected/public fields and all public methods.

PLAIN_JSON

public static final OptionPreset PLAIN_JSON

Preset: including private/package/protected/public fields and no methods.

JAVA_OBJECT

public static final OptionPreset JAVA_OBJECT

Preset: including public fields and all public methods.

Constructor Details

OptionPreset

public OptionPreset(Option... enabledByDefault)

Constructor: defining the fixed list of options to be enabled by default.

Parameters:

enabledByDefault - options in this preset

Method Details

isOptionEnabledByDefault

public boolean isOptionEnabledByDefault(Option setting)

Indicate whether the given option should be enabled, if it was not specifically included/excluded in the SchemaGeneratorConfigBuilder.

Parameters:

setting - option to check

Returns:

whether the given option is enabled by defaul

See Also:

• SchemaGeneratorConfigBuilder.with(Option, Option...)
• SchemaGeneratorConfigBuilder.without(Option, Option...)