Class FieldExclusionModule
- java.lang.Object
-
- com.github.victools.jsonschema.generator.impl.module.FieldExclusionModule
-
-
Constructor Summary
Constructors Constructor Description FieldExclusionModule(Predicate<FieldScope> shouldExcludeFieldsMatching)
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 FieldExclusionModule
forNonPublicNonStaticFieldsWithGetter()
Factory method: creating aFieldExclusionModule
instance that excludes all non-public
non-static
fields that also have an associated getter method.static FieldExclusionModule
forNonPublicNonStaticFieldsWithoutGetter()
Factory method: creating aFieldExclusionModule
instance that excludes all non-public
non-static
fields that do not have an associate getter method.static FieldExclusionModule
forPublicNonStaticFields()
Factory method: creating aFieldExclusionModule
instance that excludes allpublic
non-static
fields.static FieldExclusionModule
forTransientFields()
-
-
-
Constructor Detail
-
FieldExclusionModule
public FieldExclusionModule(Predicate<FieldScope> shouldExcludeFieldsMatching)
Constructor setting the underlying check to be set viaSchemaGeneratorConfigPart.withIgnoreCheck(Predicate)
.- Parameters:
shouldExcludeFieldsMatching
- check to identify fields to be excluded- See Also:
SchemaGeneratorConfigBuilder.forFields()
,SchemaGeneratorConfigPart.withIgnoreCheck(Predicate)
-
-
Method Detail
-
forPublicNonStaticFields
public static FieldExclusionModule forPublicNonStaticFields()
Factory method: creating aFieldExclusionModule
instance that excludes allpublic
non-static
fields.- Returns:
- created module instance
-
forNonPublicNonStaticFieldsWithGetter
public static FieldExclusionModule forNonPublicNonStaticFieldsWithGetter()
Factory method: creating aFieldExclusionModule
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 aFieldExclusionModule
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()
- 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 interfaceModule
- Parameters:
builder
- configuration builder instance to which to apply this module
-
-