Class OptionPreset
- java.lang.Object
-
- com.github.victools.jsonschema.generator.OptionPreset
-
public class OptionPreset extends Object
Selection ofOption
entries to be enabled by default, which can be overridden viaSchemaGeneratorConfigBuilder.with(Option, Option...)
/SchemaGeneratorConfigBuilder.without(Option, Option...)
.
-
-
Field Summary
Fields Modifier and Type Field Description static OptionPreset
FULL_DOCUMENTATION
Preset: including private/package/protected/public fields and all public methods.static OptionPreset
JAVA_OBJECT
Preset: including public fields and all public methods.static OptionPreset
PLAIN_JSON
Preset: including private/package/protected/public fields and no methods.
-
Constructor Summary
Constructors Constructor Description OptionPreset(Option... enabledByDefault)
Constructor: defining the fixed list of options to be enabled by default.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
isOptionEnabledByDefault(Option setting)
Indicate whether the given option should be enabled, if it was not specifically included/excluded in theSchemaGeneratorConfigBuilder
.
-
-
-
Field Detail
-
FULL_DOCUMENTATION
public static final OptionPreset FULL_DOCUMENTATION
Preset: including private/package/protected/public fields and all public methods.
-
PLAIN_JSON
public static final OptionPreset PLAIN_JSON
Preset: including private/package/protected/public fields and no methods.
-
JAVA_OBJECT
public static final OptionPreset JAVA_OBJECT
Preset: including public fields and all public methods.
-
-
Constructor Detail
-
OptionPreset
public OptionPreset(Option... enabledByDefault)
Constructor: defining the fixed list of options to be enabled by default.- Parameters:
enabledByDefault
- options in this preset
-
-
Method Detail
-
isOptionEnabledByDefault
public boolean isOptionEnabledByDefault(Option setting)
Indicate whether the given option should be enabled, if it was not specifically included/excluded in theSchemaGeneratorConfigBuilder
.- Parameters:
setting
- option to check- Returns:
- whether the given option is enabled by defaul
- See Also:
SchemaGeneratorConfigBuilder.with(Option, Option...)
,SchemaGeneratorConfigBuilder.without(Option, Option...)
-
-