Class MethodExclusionModule
java.lang.Object
com.github.victools.jsonschema.generator.impl.module.MethodExclusionModule
- All Implemented Interfaces:
Module
Default module for excluding methods.
-
Constructor Summary
ConstructorsConstructorDescriptionMethodExclusionModule(Predicate<MethodScope> shouldExcludeMethodsMatching) Constructor setting the underlying check to be set viaSchemaGeneratorConfigPart.withIgnoreCheck(Predicate). -
Method Summary
Modifier and TypeMethodDescriptionvoidApply this module to the given configuration builder instance.static MethodExclusionModuleFactory method: creating aMethodExclusionModuleinstance that excludes all getter methods.static MethodExclusionModuleFactory method: creating aMethodExclusionModuleinstance that excludes all methods that don't fall in any of the other categories.static MethodExclusionModuleFactory method: creating aMethodExclusionModuleinstance that excludes all methods with avoidreturn type.
-
Constructor Details
-
MethodExclusionModule
Constructor setting the underlying check to be set viaSchemaGeneratorConfigPart.withIgnoreCheck(Predicate).- Parameters:
shouldExcludeMethodsMatching- check to identify methods to be excluded- See Also:
-
-
Method Details
-
forVoidMethods
Factory method: creating aMethodExclusionModuleinstance that excludes all methods with avoidreturn type.- Returns:
- created module instance
-
forGetterMethods
Factory method: creating aMethodExclusionModuleinstance that excludes all getter methods.- Returns:
- created module instance
-
forNonStaticNonVoidNonGetterMethods
Factory method: creating aMethodExclusionModuleinstance that excludes all methods that don't fall in any of the other categories.- Returns:
- created module instance
- See Also:
-
applyToConfigBuilder
Description copied from interface:ModuleApply this module to the given configuration builder instance.- Specified by:
applyToConfigBuilderin interfaceModule- Parameters:
builder- configuration builder instance to which to apply this module
-