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

Class FieldExclusionModule

java.lang.Object

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

All Implemented Interfaces:

Module

public class FieldExclusionModule
extends Object
implements Module

Default module for excluding fields.

Constructor Summary

Constructors

Constructor	Description
FieldExclusionModule(Predicate<FieldScope> shouldExcludeFieldsMatching)	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 FieldExclusionModule	forNonPublicNonStaticFieldsWithGetter()	Factory method: creating a FieldExclusionModule instance that excludes all non-public non-static fields that also have an associated getter method.
static FieldExclusionModule	forNonPublicNonStaticFieldsWithoutGetter()	Factory method: creating a FieldExclusionModule instance that excludes all non-public non-static fields that do not have an associate getter method.
static FieldExclusionModule	forPublicNonStaticFields()	Factory method: creating a FieldExclusionModule instance that excludes all public non-static fields.
static FieldExclusionModule	forTransientFields()	Factory method: creating a FieldExclusionModule instance that excludes all public static fields.

Methods inherited from class java.lang.Object

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

Constructor Details

FieldExclusionModule

public FieldExclusionModule(Predicate<FieldScope> shouldExcludeFieldsMatching)

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

Parameters:

shouldExcludeFieldsMatching - check to identify fields to be excluded

See Also:

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

Method Details

forPublicNonStaticFields

public static FieldExclusionModule forPublicNonStaticFields()

Factory method: creating a FieldExclusionModule instance that excludes all public non-static fields.

Returns:

created module instance

forNonPublicNonStaticFieldsWithGetter

public static FieldExclusionModule forNonPublicNonStaticFieldsWithGetter()

Factory method: creating a FieldExclusionModule instance that excludes all non-public non-static fields that also have an associated getter method.

Returns:

created module instance

forNonPublicNonStaticFieldsWithoutGetter

public static FieldExclusionModule forNonPublicNonStaticFieldsWithoutGetter()

Factory method: creating a FieldExclusionModule instance that excludes all non-public non-static fields that do not have an associate getter method.

Returns:

created module instance

forTransientFields

public static FieldExclusionModule forTransientFields()

Factory method: creating a FieldExclusionModule instance that excludes all public static fields.

Returns:

created module instance

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