Package com.github.victools.jsonschema.generator.impl.module

Class SimplifiedOptionalModule

java.lang.Object

com.github.victools.jsonschema.generator.impl.module.SimplifiedOptionalModule

All Implemented Interfaces:

Module

public class SimplifiedOptionalModule
extends Object
implements Module

Default module being included if Option.SIMPLIFIED_OPTIONALS is enabled.

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	DEFAULT_INCLUDED_METHOD_NAMES	The method names to preserve for an Optional instance's schema representation: "get", "orElse", "isPresent".

Constructor Summary

Constructors

Constructor	Description
SimplifiedOptionalModule(String... includedMethodNames)	Constructor: setting the names of methods declared by the Optional class to include in its generated object schema.

Method Summary

Modifier and Type	Method	Description
void	applyToConfigBuilder(SchemaGeneratorConfigBuilder builder)	Apply this module to the given configuration builder instance.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_INCLUDED_METHOD_NAMES

public static final String[] DEFAULT_INCLUDED_METHOD_NAMES

The method names to preserve for an Optional instance's schema representation: "get", "orElse", "isPresent".

See Also:

• Optional.get()
• Optional.orElse(Object)
• Optional.isPresent()

Constructor Details

SimplifiedOptionalModule

public SimplifiedOptionalModule(String... includedMethodNames)

Constructor: setting the names of methods declared by the Optional class to include in its generated object schema.

Parameters:

includedMethodNames - names of the Optional class' methods to include

See Also:

• DEFAULT_INCLUDED_METHOD_NAMES

Method Details

applyToConfigBuilder

public void applyToConfigBuilder(SchemaGeneratorConfigBuilder builder)

Description copied from interface: Module

Apply this module to the given configuration builder instance.

Specified by:

applyToConfigBuilder in interface Module

Parameters:

builder - configuration builder instance to which to apply this module