AdditionalPropertiesSchema.md

AdditionalPropertiesSchema

org.openapijsonschematools.client.components.schemas.AdditionalPropertiesSchema.java public class AdditionalPropertiesSchema

A class that contains necessary nested

• schema classes (which validate payloads), extends JsonSchema
• sealed interfaces which store validated payloads, java version of a sum type
• boxed classes which store validated payloads, sealed permits class implementations
• classes to store validated map payloads, extends FrozenMap
• classes to build inputs for map payloads

Nested Class Summary

Modifier and Type	Class and Description
sealed interface	AdditionalPropertiesSchema.AdditionalPropertiesSchema1Boxed sealed interface for validated payloads
record	AdditionalPropertiesSchema.AdditionalPropertiesSchema1BoxedMap boxed class to store validated Map payloads
static class	AdditionalPropertiesSchema.AdditionalPropertiesSchema1 schema class
sealed interface	AdditionalPropertiesSchema.Schema2Boxed sealed interface for validated payloads
record	AdditionalPropertiesSchema.Schema2BoxedMap boxed class to store validated Map payloads
static class	AdditionalPropertiesSchema.Schema2 schema class
static class	AdditionalPropertiesSchema.Schema2MapBuilder builder for Map payloads
static class	AdditionalPropertiesSchema.Schema2Map output class for Map payloads
sealed interface	AdditionalPropertiesSchema.AdditionalProperties2Boxed sealed interface for validated payloads
record	AdditionalPropertiesSchema.AdditionalProperties2BoxedVoid boxed class to store validated null payloads
record	AdditionalPropertiesSchema.AdditionalProperties2BoxedBoolean boxed class to store validated boolean payloads
record	AdditionalPropertiesSchema.AdditionalProperties2BoxedNumber boxed class to store validated Number payloads
record	AdditionalPropertiesSchema.AdditionalProperties2BoxedString boxed class to store validated String payloads
record	AdditionalPropertiesSchema.AdditionalProperties2BoxedList boxed class to store validated List payloads
record	AdditionalPropertiesSchema.AdditionalProperties2BoxedMap boxed class to store validated Map payloads
static class	AdditionalPropertiesSchema.AdditionalProperties2 schema class
sealed interface	AdditionalPropertiesSchema.Schema1Boxed sealed interface for validated payloads
record	AdditionalPropertiesSchema.Schema1BoxedMap boxed class to store validated Map payloads
static class	AdditionalPropertiesSchema.Schema1 schema class
static class	AdditionalPropertiesSchema.Schema1MapBuilder builder for Map payloads
static class	AdditionalPropertiesSchema.Schema1Map output class for Map payloads
sealed interface	AdditionalPropertiesSchema.AdditionalProperties1Boxed sealed interface for validated payloads
record	AdditionalPropertiesSchema.AdditionalProperties1BoxedVoid boxed class to store validated null payloads
record	AdditionalPropertiesSchema.AdditionalProperties1BoxedBoolean boxed class to store validated boolean payloads
record	AdditionalPropertiesSchema.AdditionalProperties1BoxedNumber boxed class to store validated Number payloads
record	AdditionalPropertiesSchema.AdditionalProperties1BoxedString boxed class to store validated String payloads
record	AdditionalPropertiesSchema.AdditionalProperties1BoxedList boxed class to store validated List payloads
record	AdditionalPropertiesSchema.AdditionalProperties1BoxedMap boxed class to store validated Map payloads
static class	AdditionalPropertiesSchema.AdditionalProperties1 schema class
sealed interface	AdditionalPropertiesSchema.Schema0Boxed sealed interface for validated payloads
record	AdditionalPropertiesSchema.Schema0BoxedMap boxed class to store validated Map payloads
static class	AdditionalPropertiesSchema.Schema0 schema class
static class	AdditionalPropertiesSchema.Schema0MapBuilder builder for Map payloads
static class	AdditionalPropertiesSchema.Schema0Map output class for Map payloads
sealed interface	AdditionalPropertiesSchema.AdditionalPropertiesBoxed sealed interface for validated payloads
record	AdditionalPropertiesSchema.AdditionalPropertiesBoxedVoid boxed class to store validated null payloads
record	AdditionalPropertiesSchema.AdditionalPropertiesBoxedBoolean boxed class to store validated boolean payloads
record	AdditionalPropertiesSchema.AdditionalPropertiesBoxedNumber boxed class to store validated Number payloads
record	AdditionalPropertiesSchema.AdditionalPropertiesBoxedString boxed class to store validated String payloads
record	AdditionalPropertiesSchema.AdditionalPropertiesBoxedList boxed class to store validated List payloads
record	AdditionalPropertiesSchema.AdditionalPropertiesBoxedMap boxed class to store validated Map payloads
static class	AdditionalPropertiesSchema.AdditionalProperties schema class

AdditionalPropertiesSchema1Boxed

public sealed interface AdditionalPropertiesSchema1Boxed
permits
AdditionalPropertiesSchema1BoxedMap

sealed interface that stores validated payloads using boxed classes

AdditionalPropertiesSchema1BoxedMap

public record AdditionalPropertiesSchema1BoxedMap
implements AdditionalPropertiesSchema1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesSchema1BoxedMap(FrozenMap<@Nullable Object> data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
FrozenMap<@Nullable Object>	data() validated payload
@Nullable Object	getData() validated payload

AdditionalPropertiesSchema1

public static class AdditionalPropertiesSchema1
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(Map.class)
List<Class<? extends JsonSchema>>	allOf = List.of(     Schema0.class,     Schema1.class,     Schema2.class ;)

Method Summary

Modifier and Type	Method and Description
FrozenMap<String, @Nullable Object>	validate(Map<?, ?> arg, SchemaConfiguration configuration)
AdditionalPropertiesSchema1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
AdditionalPropertiesSchema1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

Schema2Boxed

public sealed interface Schema2Boxed
permits
Schema2BoxedMap

sealed interface that stores validated payloads using boxed classes

Schema2BoxedMap

public record Schema2BoxedMap
implements Schema2Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
Schema2BoxedMap(Schema2Map data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
Schema2Map	data() validated payload
@Nullable Object	getData() validated payload

Schema2

public static class Schema2
extends JsonSchema

A schema class that validates payloads

Code Sample

import org.openapijsonschematools.client.configurations.JsonSchemaKeywordFlags;
import org.openapijsonschematools.client.configurations.SchemaConfiguration;
import org.openapijsonschematools.client.exceptions.ValidationException;
import org.openapijsonschematools.client.schemas.validation.MapUtils;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;
import org.openapijsonschematools.client.components.schemas.AdditionalPropertiesSchema;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());

// Map validation
AdditionalPropertiesSchema.Schema2Map validatedPayload =
    AdditionalPropertiesSchema.Schema2.validate(
    new AdditionalPropertiesSchema.Schema2MapBuilder()
    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(Map.class)
Class<? extends JsonSchema>	additionalProperties = AdditionalProperties2.class

Method Summary

Modifier and Type	Method and Description
Schema2Map	validate(Map<?, ?> arg, SchemaConfiguration configuration)
Schema2BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
Schema2Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

Schema2MapBuilder

public class Schema2MapBuilder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
Schema2MapBuilder() Creates a builder that contains an empty map

Method Summary

Modifier and Type	Method and Description
Map<String, @Nullable Object>	build() Returns map input that should be used with Schema.validate
Schema2MapBuilder	additionalProperty(String key, Void value)
Schema2MapBuilder	additionalProperty(String key, boolean value)
Schema2MapBuilder	additionalProperty(String key, String value)
Schema2MapBuilder	additionalProperty(String key, int value)
Schema2MapBuilder	additionalProperty(String key, float value)
Schema2MapBuilder	additionalProperty(String key, long value)
Schema2MapBuilder	additionalProperty(String key, double value)
Schema2MapBuilder	additionalProperty(String key, List<?> value)
Schema2MapBuilder	additionalProperty(String key, Map<String, ?> value)

Schema2Map

public static class Schema2Map
extends FrozenMap<String, @Nullable Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static Schema2Map	of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
@Nullable Object	getAdditionalProperty(String name) provides type safety for additional properties

AdditionalProperties2Boxed

public sealed interface AdditionalProperties2Boxed
permits
AdditionalProperties2BoxedVoid, AdditionalProperties2BoxedBoolean, AdditionalProperties2BoxedNumber, AdditionalProperties2BoxedString, AdditionalProperties2BoxedList, AdditionalProperties2BoxedMap

sealed interface that stores validated payloads using boxed classes

AdditionalProperties2BoxedVoid

public record AdditionalProperties2BoxedVoid
implements AdditionalProperties2Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalProperties2BoxedVoid(Void data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
Void	data() validated payload
@Nullable Object	getData() validated payload

AdditionalProperties2BoxedBoolean

public record AdditionalProperties2BoxedBoolean
implements AdditionalProperties2Boxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalProperties2BoxedBoolean(boolean data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
boolean	data() validated payload
@Nullable Object	getData() validated payload

AdditionalProperties2BoxedNumber

public record AdditionalProperties2BoxedNumber
implements AdditionalProperties2Boxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalProperties2BoxedNumber(Number data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
Number	data() validated payload
@Nullable Object	getData() validated payload

AdditionalProperties2BoxedString

public record AdditionalProperties2BoxedString
implements AdditionalProperties2Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalProperties2BoxedString(String data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
String	data() validated payload
@Nullable Object	getData() validated payload

AdditionalProperties2BoxedList

public record AdditionalProperties2BoxedList
implements AdditionalProperties2Boxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalProperties2BoxedList(FrozenList<@Nullable Object> data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
FrozenList<@Nullable Object>	data() validated payload
@Nullable Object	getData() validated payload

AdditionalProperties2BoxedMap

public record AdditionalProperties2BoxedMap
implements AdditionalProperties2Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalProperties2BoxedMap(FrozenMap<@Nullable Object> data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
FrozenMap<@Nullable Object>	data() validated payload
@Nullable Object	getData() validated payload

AdditionalProperties2

public static class AdditionalProperties2
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type	Field and Description
Integer	maxLength = 5

Method Summary

Modifier and Type	Method and Description
String	validate(String arg, SchemaConfiguration configuration)
Void	validate(Void arg, SchemaConfiguration configuration)
int	validate(int arg, SchemaConfiguration configuration)
long	validate(long arg, SchemaConfiguration configuration)
float	validate(float arg, SchemaConfiguration configuration)
double	validate(double arg, SchemaConfiguration configuration)
Number	validate(Number arg, SchemaConfiguration configuration)
boolean	validate(boolean arg, SchemaConfiguration configuration)
FrozenMap<@Nullable Object>	validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object>	validate(List<?> arg, SchemaConfiguration configuration)
AdditionalProperties2BoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
AdditionalProperties2BoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
AdditionalProperties2BoxedNumber	validateAndBox(Number arg, SchemaConfiguration configuration)
AdditionalProperties2BoxedBoolean	validateAndBox(boolean arg, SchemaConfiguration configuration)
AdditionalProperties2BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
AdditionalProperties2BoxedList	validateAndBox(List<?> arg, SchemaConfiguration configuration)
AdditionalProperties2Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

Schema1Boxed

public sealed interface Schema1Boxed
permits
Schema1BoxedMap

sealed interface that stores validated payloads using boxed classes

Schema1BoxedMap

public record Schema1BoxedMap
implements Schema1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
Schema1BoxedMap(Schema1Map data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
Schema1Map	data() validated payload
@Nullable Object	getData() validated payload

Schema1

public static class Schema1
extends JsonSchema

A schema class that validates payloads

Code Sample

import org.openapijsonschematools.client.configurations.JsonSchemaKeywordFlags;
import org.openapijsonschematools.client.configurations.SchemaConfiguration;
import org.openapijsonschematools.client.exceptions.ValidationException;
import org.openapijsonschematools.client.schemas.validation.MapUtils;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;
import org.openapijsonschematools.client.components.schemas.AdditionalPropertiesSchema;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());

// Map validation
AdditionalPropertiesSchema.Schema1Map validatedPayload =
    AdditionalPropertiesSchema.Schema1.validate(
    new AdditionalPropertiesSchema.Schema1MapBuilder()
    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(Map.class)
Class<? extends JsonSchema>	additionalProperties = AdditionalProperties1.class

Method Summary

Modifier and Type	Method and Description
Schema1Map	validate(Map<?, ?> arg, SchemaConfiguration configuration)
Schema1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
Schema1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

Schema1MapBuilder

public class Schema1MapBuilder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
Schema1MapBuilder() Creates a builder that contains an empty map

Method Summary

Modifier and Type	Method and Description
Map<String, @Nullable Object>	build() Returns map input that should be used with Schema.validate
Schema1MapBuilder	additionalProperty(String key, Void value)
Schema1MapBuilder	additionalProperty(String key, boolean value)
Schema1MapBuilder	additionalProperty(String key, String value)
Schema1MapBuilder	additionalProperty(String key, int value)
Schema1MapBuilder	additionalProperty(String key, float value)
Schema1MapBuilder	additionalProperty(String key, long value)
Schema1MapBuilder	additionalProperty(String key, double value)
Schema1MapBuilder	additionalProperty(String key, List<?> value)
Schema1MapBuilder	additionalProperty(String key, Map<String, ?> value)

Schema1Map

public static class Schema1Map
extends FrozenMap<String, @Nullable Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static Schema1Map	of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
@Nullable Object	getAdditionalProperty(String name) provides type safety for additional properties

AdditionalProperties1Boxed

public sealed interface AdditionalProperties1Boxed
permits
AdditionalProperties1BoxedVoid, AdditionalProperties1BoxedBoolean, AdditionalProperties1BoxedNumber, AdditionalProperties1BoxedString, AdditionalProperties1BoxedList, AdditionalProperties1BoxedMap

sealed interface that stores validated payloads using boxed classes

AdditionalProperties1BoxedVoid

public record AdditionalProperties1BoxedVoid
implements AdditionalProperties1Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalProperties1BoxedVoid(Void data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
Void	data() validated payload
@Nullable Object	getData() validated payload

AdditionalProperties1BoxedBoolean

public record AdditionalProperties1BoxedBoolean
implements AdditionalProperties1Boxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalProperties1BoxedBoolean(boolean data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
boolean	data() validated payload
@Nullable Object	getData() validated payload

AdditionalProperties1BoxedNumber

public record AdditionalProperties1BoxedNumber
implements AdditionalProperties1Boxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalProperties1BoxedNumber(Number data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
Number	data() validated payload
@Nullable Object	getData() validated payload

AdditionalProperties1BoxedString

public record AdditionalProperties1BoxedString
implements AdditionalProperties1Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalProperties1BoxedString(String data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
String	data() validated payload
@Nullable Object	getData() validated payload

AdditionalProperties1BoxedList

public record AdditionalProperties1BoxedList
implements AdditionalProperties1Boxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalProperties1BoxedList(FrozenList<@Nullable Object> data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
FrozenList<@Nullable Object>	data() validated payload
@Nullable Object	getData() validated payload

AdditionalProperties1BoxedMap

public record AdditionalProperties1BoxedMap
implements AdditionalProperties1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalProperties1BoxedMap(FrozenMap<@Nullable Object> data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
FrozenMap<@Nullable Object>	data() validated payload
@Nullable Object	getData() validated payload

AdditionalProperties1

public static class AdditionalProperties1
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type	Field and Description
Integer	minLength = 3

Method Summary

Modifier and Type	Method and Description
String	validate(String arg, SchemaConfiguration configuration)
Void	validate(Void arg, SchemaConfiguration configuration)
int	validate(int arg, SchemaConfiguration configuration)
long	validate(long arg, SchemaConfiguration configuration)
float	validate(float arg, SchemaConfiguration configuration)
double	validate(double arg, SchemaConfiguration configuration)
Number	validate(Number arg, SchemaConfiguration configuration)
boolean	validate(boolean arg, SchemaConfiguration configuration)
FrozenMap<@Nullable Object>	validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object>	validate(List<?> arg, SchemaConfiguration configuration)
AdditionalProperties1BoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
AdditionalProperties1BoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
AdditionalProperties1BoxedNumber	validateAndBox(Number arg, SchemaConfiguration configuration)
AdditionalProperties1BoxedBoolean	validateAndBox(boolean arg, SchemaConfiguration configuration)
AdditionalProperties1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
AdditionalProperties1BoxedList	validateAndBox(List<?> arg, SchemaConfiguration configuration)
AdditionalProperties1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

Schema0Boxed

public sealed interface Schema0Boxed
permits
Schema0BoxedMap

sealed interface that stores validated payloads using boxed classes

Schema0BoxedMap

public record Schema0BoxedMap
implements Schema0Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
Schema0BoxedMap(Schema0Map data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
Schema0Map	data() validated payload
@Nullable Object	getData() validated payload

Schema0

public static class Schema0
extends JsonSchema

A schema class that validates payloads

Code Sample

import org.openapijsonschematools.client.configurations.JsonSchemaKeywordFlags;
import org.openapijsonschematools.client.configurations.SchemaConfiguration;
import org.openapijsonschematools.client.exceptions.ValidationException;
import org.openapijsonschematools.client.schemas.validation.MapUtils;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;
import org.openapijsonschematools.client.components.schemas.AdditionalPropertiesSchema;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());

// Map validation
AdditionalPropertiesSchema.Schema0Map validatedPayload =
    AdditionalPropertiesSchema.Schema0.validate(
    new AdditionalPropertiesSchema.Schema0MapBuilder()
    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(Map.class)
Class<? extends JsonSchema>	additionalProperties = AdditionalProperties.class

Method Summary

Modifier and Type	Method and Description
Schema0Map	validate(Map<?, ?> arg, SchemaConfiguration configuration)
Schema0BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
Schema0Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

Schema0MapBuilder

public class Schema0MapBuilder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
Schema0MapBuilder() Creates a builder that contains an empty map

Method Summary

Modifier and Type	Method and Description
Map<String, @Nullable Object>	build() Returns map input that should be used with Schema.validate
Schema0MapBuilder	additionalProperty(String key, Void value)
Schema0MapBuilder	additionalProperty(String key, boolean value)
Schema0MapBuilder	additionalProperty(String key, String value)
Schema0MapBuilder	additionalProperty(String key, int value)
Schema0MapBuilder	additionalProperty(String key, float value)
Schema0MapBuilder	additionalProperty(String key, long value)
Schema0MapBuilder	additionalProperty(String key, double value)
Schema0MapBuilder	additionalProperty(String key, List<?> value)
Schema0MapBuilder	additionalProperty(String key, Map<String, ?> value)

Schema0Map

public static class Schema0Map
extends FrozenMap<String, @Nullable Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static Schema0Map	of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
@Nullable Object	getAdditionalProperty(String name) provides type safety for additional properties

AdditionalPropertiesBoxed

public sealed interface AdditionalPropertiesBoxed
permits
AdditionalPropertiesBoxedVoid, AdditionalPropertiesBoxedBoolean, AdditionalPropertiesBoxedNumber, AdditionalPropertiesBoxedString, AdditionalPropertiesBoxedList, AdditionalPropertiesBoxedMap

sealed interface that stores validated payloads using boxed classes

AdditionalPropertiesBoxedVoid

public record AdditionalPropertiesBoxedVoid
implements AdditionalPropertiesBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedVoid(Void data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
Void	data() validated payload
@Nullable Object	getData() validated payload

AdditionalPropertiesBoxedBoolean

public record AdditionalPropertiesBoxedBoolean
implements AdditionalPropertiesBoxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedBoolean(boolean data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
boolean	data() validated payload
@Nullable Object	getData() validated payload

AdditionalPropertiesBoxedNumber

public record AdditionalPropertiesBoxedNumber
implements AdditionalPropertiesBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedNumber(Number data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
Number	data() validated payload
@Nullable Object	getData() validated payload

AdditionalPropertiesBoxedString

public record AdditionalPropertiesBoxedString
implements AdditionalPropertiesBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedString(String data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
String	data() validated payload
@Nullable Object	getData() validated payload

AdditionalPropertiesBoxedList

public record AdditionalPropertiesBoxedList
implements AdditionalPropertiesBoxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedList(FrozenList<@Nullable Object> data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
FrozenList<@Nullable Object>	data() validated payload
@Nullable Object	getData() validated payload

AdditionalPropertiesBoxedMap

public record AdditionalPropertiesBoxedMap
implements AdditionalPropertiesBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedMap(FrozenMap<@Nullable Object> data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
FrozenMap<@Nullable Object>	data() validated payload
@Nullable Object	getData() validated payload

AdditionalProperties

public static class AdditionalProperties
extends AnyTypeJsonSchema.AnyTypeJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.AnyTypeJsonSchema.AnyTypeJsonSchema1
validate
validateAndBox

[Back to top] [Back to Component Schemas] [Back to README]