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

Class MethodExclusionModule

java.lang.Object

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

All Implemented Interfaces:

Module

public class MethodExclusionModule
extends Object
implements Module

Default module for excluding methods.

Constructor Summary

Constructors

Constructor	Description
MethodExclusionModule(Predicate<MethodScope> shouldExcludeMethodsMatching)	Constructor setting the underlying check to be set via SchemaGeneratorConfigPart.withIgnoreCheck(Predicate).

Method Summary

Modifier and Type	Method	Description
void	applyToConfigBuilder(SchemaGeneratorConfigBuilder builder)	Apply this module to the given configuration builder instance.
static MethodExclusionModule	forGetterMethods()	Factory method: creating a MethodExclusionModule instance that excludes all getter methods.
static MethodExclusionModule	forNonStaticNonVoidNonGetterMethods()	Factory method: creating a MethodExclusionModule instance that excludes all methods that don't fall in any of the other categories.
static MethodExclusionModule	forVoidMethods()	Factory method: creating a MethodExclusionModule instance that excludes all methods with a void return type.

Methods inherited from class java.lang.Object

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

Constructor Details

MethodExclusionModule

public MethodExclusionModule(Predicate<MethodScope> shouldExcludeMethodsMatching)

Constructor setting the underlying check to be set via SchemaGeneratorConfigPart.withIgnoreCheck(Predicate).

Parameters:

shouldExcludeMethodsMatching - check to identify methods to be excluded

See Also:

• SchemaGeneratorConfigBuilder.forMethods()
• SchemaGeneratorConfigPart.withIgnoreCheck(Predicate)

Method Details

forVoidMethods

public static MethodExclusionModule forVoidMethods()

Factory method: creating a MethodExclusionModule instance that excludes all methods with a void return type.

Returns:

created module instance

forGetterMethods

public static MethodExclusionModule forGetterMethods()

Factory method: creating a MethodExclusionModule instance that excludes all getter methods.

Returns:

created module instance

forNonStaticNonVoidNonGetterMethods

public static MethodExclusionModule forNonStaticNonVoidNonGetterMethods()

Factory method: creating a MethodExclusionModule instance that excludes all methods that don't fall in any of the other categories.

Returns:

created module instance

See Also:

• forVoidMethods()
• forGetterMethods()

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