Class MethodExclusionModule
- java.lang.Object
-
- com.github.victools.jsonschema.generator.impl.module.MethodExclusionModule
-
-
Constructor Summary
Constructors Constructor Description MethodExclusionModule(Predicate<MethodScope> shouldExcludeMethodsMatching)
Constructor setting the underlying check to be set viaSchemaGeneratorConfigPart.withIgnoreCheck(Predicate)
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
applyToConfigBuilder(SchemaGeneratorConfigBuilder builder)
Apply this module to the given configuration builder instance.static MethodExclusionModule
forGetterMethods()
Factory method: creating aMethodExclusionModule
instance that excludes all getter methods.static MethodExclusionModule
forNonStaticNonVoidNonGetterMethods()
Factory method: creating aMethodExclusionModule
instance that excludes all methods that don't fall in any of the other categories.static MethodExclusionModule
forVoidMethods()
Factory method: creating aMethodExclusionModule
instance that excludes all methods with avoid
return type.
-
-
-
Constructor Detail
-
MethodExclusionModule
public MethodExclusionModule(Predicate<MethodScope> shouldExcludeMethodsMatching)
Constructor setting the underlying check to be set viaSchemaGeneratorConfigPart.withIgnoreCheck(Predicate)
.- Parameters:
shouldExcludeMethodsMatching
- check to identify methods to be excluded- See Also:
SchemaGeneratorConfigBuilder.forMethods()
,SchemaGeneratorConfigPart.withIgnoreCheck(Predicate)
-
-
Method Detail
-
forVoidMethods
public static MethodExclusionModule forVoidMethods()
Factory method: creating aMethodExclusionModule
instance that excludes all methods with avoid
return type.- Returns:
- created module instance
-
forGetterMethods
public static MethodExclusionModule forGetterMethods()
Factory method: creating aMethodExclusionModule
instance that excludes all getter methods.- Returns:
- created module instance
-
forNonStaticNonVoidNonGetterMethods
public static MethodExclusionModule forNonStaticNonVoidNonGetterMethods()
Factory method: creating aMethodExclusionModule
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 interfaceModule
- Parameters:
builder
- configuration builder instance to which to apply this module
-
-