NullableClass

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

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 list payloads, extends FrozenList
classes to build inputs for list payloads
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	NullableClass.NullableClass1Boxed sealed interface for validated payloads
record	NullableClass.NullableClass1BoxedMap boxed class to store validated Map payloads
static class	NullableClass.NullableClass1 schema class
static class	NullableClass.NullableClassMapBuilder builder for Map payloads
static class	NullableClass.NullableClassMap output class for Map payloads
sealed interface	NullableClass.ObjectItemsNullableBoxed sealed interface for validated payloads
record	NullableClass.ObjectItemsNullableBoxedMap boxed class to store validated Map payloads
static class	NullableClass.ObjectItemsNullable schema class
static class	NullableClass.ObjectItemsNullableMapBuilder builder for Map payloads
static class	NullableClass.ObjectItemsNullableMap output class for Map payloads
sealed interface	NullableClass.AdditionalProperties2Boxed sealed interface for validated payloads
record	NullableClass.AdditionalProperties2BoxedVoid boxed class to store validated null payloads
record	NullableClass.AdditionalProperties2BoxedMap boxed class to store validated Map payloads
static class	NullableClass.AdditionalProperties2 schema class
sealed interface	NullableClass.ObjectAndItemsNullablePropBoxed sealed interface for validated payloads
record	NullableClass.ObjectAndItemsNullablePropBoxedVoid boxed class to store validated null payloads
record	NullableClass.ObjectAndItemsNullablePropBoxedMap boxed class to store validated Map payloads
static class	NullableClass.ObjectAndItemsNullableProp schema class
static class	NullableClass.ObjectAndItemsNullablePropMapBuilder builder for Map payloads
static class	NullableClass.ObjectAndItemsNullablePropMap output class for Map payloads
sealed interface	NullableClass.AdditionalProperties1Boxed sealed interface for validated payloads
record	NullableClass.AdditionalProperties1BoxedVoid boxed class to store validated null payloads
record	NullableClass.AdditionalProperties1BoxedMap boxed class to store validated Map payloads
static class	NullableClass.AdditionalProperties1 schema class
sealed interface	NullableClass.ObjectNullablePropBoxed sealed interface for validated payloads
record	NullableClass.ObjectNullablePropBoxedVoid boxed class to store validated null payloads
record	NullableClass.ObjectNullablePropBoxedMap boxed class to store validated Map payloads
static class	NullableClass.ObjectNullableProp schema class
static class	NullableClass.ObjectNullablePropMapBuilder builder for Map payloads
static class	NullableClass.ObjectNullablePropMap output class for Map payloads
sealed interface	NullableClass.AdditionalPropertiesBoxed sealed interface for validated payloads
record	NullableClass.AdditionalPropertiesBoxedMap boxed class to store validated Map payloads
static class	NullableClass.AdditionalProperties schema class
sealed interface	NullableClass.ArrayItemsNullableBoxed sealed interface for validated payloads
record	NullableClass.ArrayItemsNullableBoxedList boxed class to store validated List payloads
static class	NullableClass.ArrayItemsNullable schema class
static class	NullableClass.ArrayItemsNullableListBuilder builder for List payloads
static class	NullableClass.ArrayItemsNullableList output class for List payloads
sealed interface	NullableClass.Items2Boxed sealed interface for validated payloads
record	NullableClass.Items2BoxedVoid boxed class to store validated null payloads
record	NullableClass.Items2BoxedMap boxed class to store validated Map payloads
static class	NullableClass.Items2 schema class
sealed interface	NullableClass.ArrayAndItemsNullablePropBoxed sealed interface for validated payloads
record	NullableClass.ArrayAndItemsNullablePropBoxedVoid boxed class to store validated null payloads
record	NullableClass.ArrayAndItemsNullablePropBoxedList boxed class to store validated List payloads
static class	NullableClass.ArrayAndItemsNullableProp schema class
static class	NullableClass.ArrayAndItemsNullablePropListBuilder builder for List payloads
static class	NullableClass.ArrayAndItemsNullablePropList output class for List payloads
sealed interface	NullableClass.Items1Boxed sealed interface for validated payloads
record	NullableClass.Items1BoxedVoid boxed class to store validated null payloads
record	NullableClass.Items1BoxedMap boxed class to store validated Map payloads
static class	NullableClass.Items1 schema class
sealed interface	NullableClass.ArrayNullablePropBoxed sealed interface for validated payloads
record	NullableClass.ArrayNullablePropBoxedVoid boxed class to store validated null payloads
record	NullableClass.ArrayNullablePropBoxedList boxed class to store validated List payloads
static class	NullableClass.ArrayNullableProp schema class
static class	NullableClass.ArrayNullablePropListBuilder builder for List payloads
static class	NullableClass.ArrayNullablePropList output class for List payloads
sealed interface	NullableClass.ItemsBoxed sealed interface for validated payloads
record	NullableClass.ItemsBoxedMap boxed class to store validated Map payloads
static class	NullableClass.Items schema class
sealed interface	NullableClass.DatetimePropBoxed sealed interface for validated payloads
record	NullableClass.DatetimePropBoxedVoid boxed class to store validated null payloads
record	NullableClass.DatetimePropBoxedString boxed class to store validated String payloads
static class	NullableClass.DatetimeProp schema class
sealed interface	NullableClass.DatePropBoxed sealed interface for validated payloads
record	NullableClass.DatePropBoxedVoid boxed class to store validated null payloads
record	NullableClass.DatePropBoxedString boxed class to store validated String payloads
static class	NullableClass.DateProp schema class
sealed interface	NullableClass.StringPropBoxed sealed interface for validated payloads
record	NullableClass.StringPropBoxedVoid boxed class to store validated null payloads
record	NullableClass.StringPropBoxedString boxed class to store validated String payloads
static class	NullableClass.StringProp schema class
sealed interface	NullableClass.BooleanPropBoxed sealed interface for validated payloads
record	NullableClass.BooleanPropBoxedVoid boxed class to store validated null payloads
record	NullableClass.BooleanPropBoxedBoolean boxed class to store validated boolean payloads
static class	NullableClass.BooleanProp schema class
sealed interface	NullableClass.NumberPropBoxed sealed interface for validated payloads
record	NullableClass.NumberPropBoxedVoid boxed class to store validated null payloads
record	NullableClass.NumberPropBoxedNumber boxed class to store validated Number payloads
static class	NullableClass.NumberProp schema class
sealed interface	NullableClass.IntegerPropBoxed sealed interface for validated payloads
record	NullableClass.IntegerPropBoxedVoid boxed class to store validated null payloads
record	NullableClass.IntegerPropBoxedNumber boxed class to store validated Number payloads
static class	NullableClass.IntegerProp schema class
sealed interface	NullableClass.AdditionalProperties3Boxed sealed interface for validated payloads
record	NullableClass.AdditionalProperties3BoxedVoid boxed class to store validated null payloads
record	NullableClass.AdditionalProperties3BoxedMap boxed class to store validated Map payloads
static class	NullableClass.AdditionalProperties3 schema class

NullableClass1Boxed

public sealed interface NullableClass1Boxed
permits
NullableClass1BoxedMap

sealed interface that stores validated payloads using boxed classes

NullableClass1BoxedMap

public record NullableClass1BoxedMap
implements NullableClass1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
NullableClass1BoxedMap(NullableClassMap data) Creates an instance, private visibility

Method Summary

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

NullableClass1

public static class NullableClass1
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.NullableClass;

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

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

// Map validation
NullableClass.NullableClassMap validatedPayload =
    NullableClass.NullableClass1.validate(
    new NullableClass.NullableClassMapBuilder()
        .integer_prop(null)

        .number_prop(null)

        .boolean_prop(null)

        .string_prop(null)

        .date_prop(null)

        .datetime_prop(null)

        .array_nullable_prop(null)

        .array_and_items_nullable_prop(null)

        .array_items_nullable(
            Arrays.asList(
                null
            )
        )
        .object_nullable_prop(null)

        .object_and_items_nullable_prop(null)

        .object_items_nullable(
            MapUtils.makeMap(
                new AbstractMap.SimpleEntry<String, Void>(
                    "someAdditionalProperty",
                    null
                )
            )
        )
        .additionalProperty("someAdditionalProperty", null)

    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(Map.class)
Map<String, Class<? extends JsonSchema>>	properties = Map.ofEntries( new PropertyEntry("integer_prop", IntegerProp.class)), new PropertyEntry("number_prop", NumberProp.class)), new PropertyEntry("boolean_prop", BooleanProp.class)), new PropertyEntry("string_prop", StringProp.class)), new PropertyEntry("date_prop", DateProp.class)), new PropertyEntry("datetime_prop", DatetimeProp.class)), new PropertyEntry("array_nullable_prop", ArrayNullableProp.class)), new PropertyEntry("array_and_items_nullable_prop", ArrayAndItemsNullableProp.class)), new PropertyEntry("array_items_nullable", ArrayItemsNullable.class)), new PropertyEntry("object_nullable_prop", ObjectNullableProp.class)), new PropertyEntry("object_and_items_nullable_prop", ObjectAndItemsNullableProp.class)), new PropertyEntry("object_items_nullable", ObjectItemsNullable.class)) )
Class<? extends JsonSchema>	additionalProperties = AdditionalProperties3.class

Method Summary

Modifier and Type	Method and Description
NullableClassMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
NullableClass1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
NullableClass1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

NullableClassMapBuilder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
NullableClassMapBuilder() 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
NullableClassMapBuilder	integer_prop(Void value)
NullableClassMapBuilder	integer_prop(int value)
NullableClassMapBuilder	integer_prop(float value)
NullableClassMapBuilder	integer_prop(long value)
NullableClassMapBuilder	integer_prop(double value)
NullableClassMapBuilder	number_prop(Void value)
NullableClassMapBuilder	number_prop(int value)
NullableClassMapBuilder	number_prop(float value)
NullableClassMapBuilder	number_prop(long value)
NullableClassMapBuilder	number_prop(double value)
NullableClassMapBuilder	boolean_prop(Void value)
NullableClassMapBuilder	boolean_prop(boolean value)
NullableClassMapBuilder	string_prop(Void value)
NullableClassMapBuilder	string_prop(String value)
NullableClassMapBuilder	date_prop(Void value)
NullableClassMapBuilder	date_prop(String value)
NullableClassMapBuilder	datetime_prop(Void value)
NullableClassMapBuilder	datetime_prop(String value)
NullableClassMapBuilder	array_nullable_prop(Void value)
NullableClassMapBuilder	array_nullable_prop(List<Map<String, @Nullable Object>> value)
NullableClassMapBuilder	array_and_items_nullable_prop(Void value)
NullableClassMapBuilder	array_and_items_nullable_prop(List<@Nullable Map<String, @Nullable Object>> value)
NullableClassMapBuilder	array_items_nullable(List<@Nullable Map<String, @Nullable Object>> value)
NullableClassMapBuilder	object_nullable_prop(Void value)
NullableClassMapBuilder	object_nullable_prop(Map<String, Map<String, @Nullable Object>> value)
NullableClassMapBuilder	object_and_items_nullable_prop(Void value)
NullableClassMapBuilder	object_and_items_nullable_prop(Map<String, @Nullable Map<String, @Nullable Object>> value)
NullableClassMapBuilder	object_items_nullable(Map<String, @Nullable Map<String, @Nullable Object>> value)
NullableClassMapBuilder	additionalProperty(String key, Void value)
NullableClassMapBuilder	additionalProperty(String key, Map<String, @Nullable Object> value)

NullableClassMap

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

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static NullableClassMap	of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
@Nullable Number	integer_prop() [optional]
@Nullable Number	number_prop() [optional]
@Nullable Boolean	boolean_prop() [optional]
@Nullable String	string_prop() [optional]
@Nullable String	date_prop() [optional] value must conform to RFC-3339 full-date YYYY-MM-DD
@Nullable String	datetime_prop() [optional] value must conform to RFC-3339 date-time
ArrayNullablePropList	array_nullable_prop() [optional]
ArrayAndItemsNullablePropList	array_and_items_nullable_prop() [optional]
ArrayItemsNullableList	array_items_nullable() [optional]
ObjectNullablePropMap	object_nullable_prop() [optional]
ObjectAndItemsNullablePropMap	object_and_items_nullable_prop() [optional]
ObjectItemsNullableMap	object_items_nullable() [optional]
@Nullable FrozenMap<?>	getAdditionalProperty(String name) provides type safety for additional properties

ObjectItemsNullableBoxed

public sealed interface ObjectItemsNullableBoxed
permits
ObjectItemsNullableBoxedMap

sealed interface that stores validated payloads using boxed classes

ObjectItemsNullableBoxedMap

public record ObjectItemsNullableBoxedMap
implements ObjectItemsNullableBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ObjectItemsNullableBoxedMap(ObjectItemsNullableMap data) Creates an instance, private visibility

Method Summary

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

ObjectItemsNullable

public static class ObjectItemsNullable
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.NullableClass;

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

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

// Map validation
NullableClass.ObjectItemsNullableMap validatedPayload =
    NullableClass.ObjectItemsNullable.validate(
    new NullableClass.ObjectItemsNullableMapBuilder()
        .additionalProperty("someAdditionalProperty", null)

    .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
ObjectItemsNullableMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
ObjectItemsNullableBoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
ObjectItemsNullableBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ObjectItemsNullableMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Map<String, @Nullable Map<String, @Nullable Object>>	build() Returns map input that should be used with Schema.validate
ObjectItemsNullableMapBuilder	additionalProperty(String key, Void value)
ObjectItemsNullableMapBuilder	additionalProperty(String key, Map<String, @Nullable Object> value)

ObjectItemsNullableMap

public static class ObjectItemsNullableMap
extends FrozenMap<String, @Nullable FrozenMap<?>>

A class to store validated Map payloads

Method Summary

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

AdditionalProperties2Boxed

public sealed interface AdditionalProperties2Boxed
permits
AdditionalProperties2BoxedVoid, 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

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

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.NullableClass;

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

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

// null validation
Void validatedPayload = NullableClass.AdditionalProperties2.validate(
    (Void) null,
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of( Void.class, Map.class )

Method Summary

Modifier and Type	Method and Description
Void	validate(Void arg, SchemaConfiguration configuration)
AdditionalProperties2BoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
FrozenMap<String, @Nullable Object>	validate(Map<?, ?> arg, SchemaConfiguration configuration)
AdditionalProperties2BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
AdditionalProperties2Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ObjectAndItemsNullablePropBoxed

public sealed interface ObjectAndItemsNullablePropBoxed
permits
ObjectAndItemsNullablePropBoxedVoid, ObjectAndItemsNullablePropBoxedMap

sealed interface that stores validated payloads using boxed classes

ObjectAndItemsNullablePropBoxedVoid

public record ObjectAndItemsNullablePropBoxedVoid
implements ObjectAndItemsNullablePropBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

ObjectAndItemsNullablePropBoxedMap

public record ObjectAndItemsNullablePropBoxedMap
implements ObjectAndItemsNullablePropBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ObjectAndItemsNullablePropBoxedMap(ObjectAndItemsNullablePropMap data) Creates an instance, private visibility

Method Summary

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

ObjectAndItemsNullableProp

public static class ObjectAndItemsNullableProp
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.NullableClass;

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

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

// null validation
Void validatedPayload = NullableClass.ObjectAndItemsNullableProp.validate(
    (Void) null,
    configuration
);

// Map validation
NullableClass.ObjectAndItemsNullablePropMap validatedPayload =
    NullableClass.ObjectAndItemsNullableProp.validate(
    new NullableClass.ObjectAndItemsNullablePropMapBuilder()
        .additionalProperty("someAdditionalProperty", null)

    .build(),
    configuration
);

Field Summary

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

Method Summary

Modifier and Type	Method and Description
Void	validate(Void arg, SchemaConfiguration configuration)
ObjectAndItemsNullablePropBoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
ObjectAndItemsNullablePropMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
ObjectAndItemsNullablePropBoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
ObjectAndItemsNullablePropBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ObjectAndItemsNullablePropMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Map<String, @Nullable Map<String, @Nullable Object>>	build() Returns map input that should be used with Schema.validate
ObjectAndItemsNullablePropMapBuilder	additionalProperty(String key, Void value)
ObjectAndItemsNullablePropMapBuilder	additionalProperty(String key, Map<String, @Nullable Object> value)

ObjectAndItemsNullablePropMap

public static class ObjectAndItemsNullablePropMap
extends FrozenMap<String, @Nullable FrozenMap<?>>

A class to store validated Map payloads

Method Summary

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

AdditionalProperties1Boxed

public sealed interface AdditionalProperties1Boxed
permits
AdditionalProperties1BoxedVoid, 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

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

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.NullableClass;

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

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

// null validation
Void validatedPayload = NullableClass.AdditionalProperties1.validate(
    (Void) null,
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of( Void.class, Map.class )

Method Summary

Modifier and Type	Method and Description
Void	validate(Void arg, SchemaConfiguration configuration)
AdditionalProperties1BoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
FrozenMap<String, @Nullable Object>	validate(Map<?, ?> arg, SchemaConfiguration configuration)
AdditionalProperties1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
AdditionalProperties1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ObjectNullablePropBoxed

public sealed interface ObjectNullablePropBoxed
permits
ObjectNullablePropBoxedVoid, ObjectNullablePropBoxedMap

sealed interface that stores validated payloads using boxed classes

ObjectNullablePropBoxedVoid

public record ObjectNullablePropBoxedVoid
implements ObjectNullablePropBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

ObjectNullablePropBoxedMap

public record ObjectNullablePropBoxedMap
implements ObjectNullablePropBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ObjectNullablePropBoxedMap(ObjectNullablePropMap data) Creates an instance, private visibility

Method Summary

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

ObjectNullableProp

public static class ObjectNullableProp
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.NullableClass;

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

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

// null validation
Void validatedPayload = NullableClass.ObjectNullableProp.validate(
    (Void) null,
    configuration
);

// Map validation
NullableClass.ObjectNullablePropMap validatedPayload =
    NullableClass.ObjectNullableProp.validate(
    new NullableClass.ObjectNullablePropMapBuilder()
    .build(),
    configuration
);

Field Summary

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

Method Summary

Modifier and Type	Method and Description
Void	validate(Void arg, SchemaConfiguration configuration)
ObjectNullablePropBoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
ObjectNullablePropMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
ObjectNullablePropBoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
ObjectNullablePropBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ObjectNullablePropMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Map<String, Map<String, @Nullable Object>>	build() Returns map input that should be used with Schema.validate
ObjectNullablePropMapBuilder	additionalProperty(String key, Map<String, @Nullable Object> value)

ObjectNullablePropMap

public static class ObjectNullablePropMap
extends FrozenMap<String, FrozenMap<?>>

A class to store validated Map payloads

Method Summary

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

AdditionalPropertiesBoxed

public sealed interface AdditionalPropertiesBoxed
permits
AdditionalPropertiesBoxedMap

sealed interface that stores validated payloads using boxed classes

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 MapJsonSchema.MapJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.MapJsonSchema.MapJsonSchema1
validate
validateAndBox

ArrayItemsNullableBoxed

public sealed interface ArrayItemsNullableBoxed
permits
ArrayItemsNullableBoxedList

sealed interface that stores validated payloads using boxed classes

ArrayItemsNullableBoxedList

public record ArrayItemsNullableBoxedList
implements ArrayItemsNullableBoxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ArrayItemsNullableBoxedList(ArrayItemsNullableList data) Creates an instance, private visibility

Method Summary

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

ArrayItemsNullable

public static class ArrayItemsNullable
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.NullableClass;

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

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

// List validation
NullableClass.ArrayItemsNullableList validatedPayload =
    NullableClass.ArrayItemsNullable.validate(
    new NullableClass.ArrayItemsNullableListBuilder()
        .add((Void) null)

    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(List.class)
Class<? extends JsonSchema>	items = Items2.class

Method Summary

Modifier and Type	Method and Description
ArrayItemsNullableList	validate(List<?> arg, SchemaConfiguration configuration)
ArrayItemsNullableBoxedList	validateAndBox(List<?> arg, SchemaConfiguration configuration)
ArrayItemsNullableBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ArrayItemsNullableListBuilder

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

A class that builds the List input type

Constructor Summary

Constructor and Description
ArrayItemsNullableListBuilder() Creates an empty list
ArrayItemsNullableListBuilder(List<@Nullable Map<String, @Nullable Object>> items) Stores the items in a list

Method Summary

Modifier and Type	Method and Description
ArrayItemsNullableListBuilder	add(Void item)
ArrayItemsNullableListBuilder	add(Map<String, @Nullable Object> item)
List<@Nullable Map<String, @Nullable Object>>	build() Returns list input that should be used with Schema.validate

ArrayItemsNullableList

public class ArrayItemsNullableList
extends FrozenList<@Nullable FrozenMap<?>>

A class to store validated List payloads

Method Summary

Modifier and Type	Method and Description
static ArrayItemsNullableList	of(List<? extends @Nullable Map<String, ? extends @Nullable Object>> arg, SchemaConfiguration configuration)

Items2Boxed

public sealed interface Items2Boxed
permits
Items2BoxedVoid, Items2BoxedMap

sealed interface that stores validated payloads using boxed classes

Items2BoxedVoid

public record Items2BoxedVoid
implements Items2Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Items2BoxedMap

public record Items2BoxedMap
implements Items2Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
Items2BoxedMap(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

Items2

public static class Items2
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.NullableClass;

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

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

// null validation
Void validatedPayload = NullableClass.Items2.validate(
    (Void) null,
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of( Void.class, Map.class )

Method Summary

Modifier and Type	Method and Description
Void	validate(Void arg, SchemaConfiguration configuration)
Items2BoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
FrozenMap<String, @Nullable Object>	validate(Map<?, ?> arg, SchemaConfiguration configuration)
Items2BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
Items2Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ArrayAndItemsNullablePropBoxed

public sealed interface ArrayAndItemsNullablePropBoxed
permits
ArrayAndItemsNullablePropBoxedVoid, ArrayAndItemsNullablePropBoxedList

sealed interface that stores validated payloads using boxed classes

ArrayAndItemsNullablePropBoxedVoid

public record ArrayAndItemsNullablePropBoxedVoid
implements ArrayAndItemsNullablePropBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

ArrayAndItemsNullablePropBoxedList

public record ArrayAndItemsNullablePropBoxedList
implements ArrayAndItemsNullablePropBoxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ArrayAndItemsNullablePropBoxedList(ArrayAndItemsNullablePropList data) Creates an instance, private visibility

Method Summary

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

ArrayAndItemsNullableProp

public static class ArrayAndItemsNullableProp
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.NullableClass;

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

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

// null validation
Void validatedPayload = NullableClass.ArrayAndItemsNullableProp.validate(
    (Void) null,
    configuration
);

// List validation
NullableClass.ArrayAndItemsNullablePropList validatedPayload =
    NullableClass.ArrayAndItemsNullableProp.validate(
    new NullableClass.ArrayAndItemsNullablePropListBuilder()
        .add((Void) null)

    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of( Void.class, List.class )
Class<? extends JsonSchema>	items = Items1.class

Method Summary

Modifier and Type	Method and Description
Void	validate(Void arg, SchemaConfiguration configuration)
ArrayAndItemsNullablePropBoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
ArrayAndItemsNullablePropList	validate(List<?> arg, SchemaConfiguration configuration)
ArrayAndItemsNullablePropBoxedList	validateAndBox(List<?> arg, SchemaConfiguration configuration)
ArrayAndItemsNullablePropBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ArrayAndItemsNullablePropListBuilder

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

A class that builds the List input type

Constructor Summary

Constructor and Description
ArrayAndItemsNullablePropListBuilder() Creates an empty list
ArrayAndItemsNullablePropListBuilder(List<@Nullable Map<String, @Nullable Object>> items) Stores the items in a list

Method Summary

Modifier and Type	Method and Description
ArrayAndItemsNullablePropListBuilder	add(Void item)
ArrayAndItemsNullablePropListBuilder	add(Map<String, @Nullable Object> item)
List<@Nullable Map<String, @Nullable Object>>	build() Returns list input that should be used with Schema.validate

ArrayAndItemsNullablePropList

public class ArrayAndItemsNullablePropList
extends FrozenList<@Nullable FrozenMap<?>>

A class to store validated List payloads

Method Summary

Modifier and Type	Method and Description
static ArrayAndItemsNullablePropList	of(List<? extends @Nullable Map<String, ? extends @Nullable Object>> arg, SchemaConfiguration configuration)

Items1Boxed

public sealed interface Items1Boxed
permits
Items1BoxedVoid, Items1BoxedMap

sealed interface that stores validated payloads using boxed classes

Items1BoxedVoid

public record Items1BoxedVoid
implements Items1Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Items1BoxedMap

public record Items1BoxedMap
implements Items1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
Items1BoxedMap(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

Items1

public static class Items1
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.NullableClass;

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

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

// null validation
Void validatedPayload = NullableClass.Items1.validate(
    (Void) null,
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of( Void.class, Map.class )

Method Summary

Modifier and Type	Method and Description
Void	validate(Void arg, SchemaConfiguration configuration)
Items1BoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
FrozenMap<String, @Nullable Object>	validate(Map<?, ?> arg, SchemaConfiguration configuration)
Items1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
Items1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ArrayNullablePropBoxed

public sealed interface ArrayNullablePropBoxed
permits
ArrayNullablePropBoxedVoid, ArrayNullablePropBoxedList

sealed interface that stores validated payloads using boxed classes

ArrayNullablePropBoxedVoid

public record ArrayNullablePropBoxedVoid
implements ArrayNullablePropBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

ArrayNullablePropBoxedList

public record ArrayNullablePropBoxedList
implements ArrayNullablePropBoxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ArrayNullablePropBoxedList(ArrayNullablePropList data) Creates an instance, private visibility

Method Summary

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

ArrayNullableProp

public static class ArrayNullableProp
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.NullableClass;

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

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

// null validation
Void validatedPayload = NullableClass.ArrayNullableProp.validate(
    (Void) null,
    configuration
);

// List validation
NullableClass.ArrayNullablePropList validatedPayload =
    NullableClass.ArrayNullableProp.validate(
    new NullableClass.ArrayNullablePropListBuilder()
    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of( Void.class, List.class )
Class<? extends JsonSchema>	items = Items.class

Method Summary

Modifier and Type	Method and Description
Void	validate(Void arg, SchemaConfiguration configuration)
ArrayNullablePropBoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
ArrayNullablePropList	validate(List<?> arg, SchemaConfiguration configuration)
ArrayNullablePropBoxedList	validateAndBox(List<?> arg, SchemaConfiguration configuration)
ArrayNullablePropBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ArrayNullablePropListBuilder

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

A class that builds the List input type

Constructor Summary

Constructor and Description
ArrayNullablePropListBuilder() Creates an empty list
ArrayNullablePropListBuilder(List<Map<String, @Nullable Object>> items) Stores the items in a list

Method Summary

Modifier and Type	Method and Description
ArrayNullablePropListBuilder	add(Map<String, @Nullable Object> item)
List<Map<String, @Nullable Object>>	build() Returns list input that should be used with Schema.validate

ArrayNullablePropList

public class ArrayNullablePropList
extends FrozenList<FrozenMap<?>>

A class to store validated List payloads

Method Summary

Modifier and Type	Method and Description
static ArrayNullablePropList	of(List<Map<String, ? extends @Nullable Object>> arg, SchemaConfiguration configuration)

ItemsBoxed

public sealed interface ItemsBoxed
permits
ItemsBoxedMap

sealed interface that stores validated payloads using boxed classes

ItemsBoxedMap

public record ItemsBoxedMap
implements ItemsBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ItemsBoxedMap(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

Items

public static class Items
extends MapJsonSchema.MapJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.MapJsonSchema.MapJsonSchema1
validate
validateAndBox

DatetimePropBoxed

public sealed interface DatetimePropBoxed
permits
DatetimePropBoxedVoid, DatetimePropBoxedString

sealed interface that stores validated payloads using boxed classes

DatetimePropBoxedVoid

public record DatetimePropBoxedVoid
implements DatetimePropBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

DatetimePropBoxedString

public record DatetimePropBoxedString
implements DatetimePropBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

DatetimeProp

public static class DatetimeProp
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.NullableClass;

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

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

// null validation
Void validatedPayload = NullableClass.DatetimeProp.validate(
    (Void) null,
    configuration
);

// String validation
String validatedPayload = NullableClass.DatetimeProp.validate(
    "1970-01-01T00:00:00.00Z",
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of( Void.class, String.class )
String	type = "date-time";

Method Summary

Modifier and Type	Method and Description
Void	validate(Void arg, SchemaConfiguration configuration)
DatetimePropBoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
String	validate(String arg, SchemaConfiguration configuration)
DatetimePropBoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
DatetimePropBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

DatePropBoxed

public sealed interface DatePropBoxed
permits
DatePropBoxedVoid, DatePropBoxedString

sealed interface that stores validated payloads using boxed classes

DatePropBoxedVoid

public record DatePropBoxedVoid
implements DatePropBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

DatePropBoxedString

public record DatePropBoxedString
implements DatePropBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

DateProp

public static class DateProp
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.NullableClass;

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

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

// null validation
Void validatedPayload = NullableClass.DateProp.validate(
    (Void) null,
    configuration
);

// String validation
String validatedPayload = NullableClass.DateProp.validate(
    "2020-12-13",
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of( Void.class, String.class )
String	type = "date";

Method Summary

Modifier and Type	Method and Description
Void	validate(Void arg, SchemaConfiguration configuration)
DatePropBoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
String	validate(String arg, SchemaConfiguration configuration)
DatePropBoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
DatePropBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

StringPropBoxed

public sealed interface StringPropBoxed
permits
StringPropBoxedVoid, StringPropBoxedString

sealed interface that stores validated payloads using boxed classes

StringPropBoxedVoid

public record StringPropBoxedVoid
implements StringPropBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

StringPropBoxedString

public record StringPropBoxedString
implements StringPropBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

StringProp

public static class StringProp
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.NullableClass;

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

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

// null validation
Void validatedPayload = NullableClass.StringProp.validate(
    (Void) null,
    configuration
);

// String validation
String validatedPayload = NullableClass.StringProp.validate(
    "a",
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of( Void.class, String.class )

Method Summary

Modifier and Type	Method and Description
Void	validate(Void arg, SchemaConfiguration configuration)
StringPropBoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
String	validate(String arg, SchemaConfiguration configuration)
StringPropBoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
StringPropBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

BooleanPropBoxed

public sealed interface BooleanPropBoxed
permits
BooleanPropBoxedVoid, BooleanPropBoxedBoolean

sealed interface that stores validated payloads using boxed classes

BooleanPropBoxedVoid

public record BooleanPropBoxedVoid
implements BooleanPropBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

BooleanPropBoxedBoolean

public record BooleanPropBoxedBoolean
implements BooleanPropBoxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

BooleanProp

public static class BooleanProp
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.NullableClass;

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

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

// null validation
Void validatedPayload = NullableClass.BooleanProp.validate(
    (Void) null,
    configuration
);

// boolean validation
boolean validatedPayload = NullableClass.BooleanProp.validate(
    true,
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of( Void.class, Boolean.class )

Method Summary

Modifier and Type	Method and Description
Void	validate(Void arg, SchemaConfiguration configuration)
BooleanPropBoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
boolean	validate(boolean arg, SchemaConfiguration configuration)
BooleanPropBoxedBoolean	validateAndBox(boolean arg, SchemaConfiguration configuration)
BooleanPropBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

NumberPropBoxed

public sealed interface NumberPropBoxed
permits
NumberPropBoxedVoid, NumberPropBoxedNumber

sealed interface that stores validated payloads using boxed classes

NumberPropBoxedVoid

public record NumberPropBoxedVoid
implements NumberPropBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

NumberPropBoxedNumber

public record NumberPropBoxedNumber
implements NumberPropBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

NumberProp

public static class NumberProp
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.NullableClass;

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

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

// null validation
Void validatedPayload = NullableClass.NumberProp.validate(
    (Void) null,
    configuration
);

// int validation
int validatedPayload = NullableClass.NumberProp.validate(
    1,
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of( Void.class, Integer.class, Long.class, Float.class, Double.class )

Method Summary

Modifier and Type	Method and Description
Void	validate(Void arg, SchemaConfiguration configuration)
NumberPropBoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
Number	validate(Number arg, SchemaConfiguration configuration)
NumberPropBoxedNumber	validateAndBox(Number arg, SchemaConfiguration configuration)
NumberPropBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

IntegerPropBoxed

public sealed interface IntegerPropBoxed
permits
IntegerPropBoxedVoid, IntegerPropBoxedNumber

sealed interface that stores validated payloads using boxed classes

IntegerPropBoxedVoid

public record IntegerPropBoxedVoid
implements IntegerPropBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

IntegerPropBoxedNumber

public record IntegerPropBoxedNumber
implements IntegerPropBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

IntegerProp

public static class IntegerProp
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.NullableClass;

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

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

// null validation
Void validatedPayload = NullableClass.IntegerProp.validate(
    (Void) null,
    configuration
);

// int validation
int validatedPayload = NullableClass.IntegerProp.validate(
    1L,
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of( Void.class, Integer.class, Long.class, Float.class, Double.class )
String	type = "int";

Method Summary

Modifier and Type	Method and Description
Void	validate(Void arg, SchemaConfiguration configuration)
IntegerPropBoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
long	validate(long arg, SchemaConfiguration configuration)
IntegerPropBoxedNumber	validateAndBox(Number arg, SchemaConfiguration configuration)
IntegerPropBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

AdditionalProperties3Boxed

public sealed interface AdditionalProperties3Boxed
permits
AdditionalProperties3BoxedVoid, AdditionalProperties3BoxedMap

sealed interface that stores validated payloads using boxed classes

AdditionalProperties3BoxedVoid

public record AdditionalProperties3BoxedVoid
implements AdditionalProperties3Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

AdditionalProperties3BoxedMap

public record AdditionalProperties3BoxedMap
implements AdditionalProperties3Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalProperties3BoxedMap(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

AdditionalProperties3

public static class AdditionalProperties3
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.NullableClass;

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

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

// null validation
Void validatedPayload = NullableClass.AdditionalProperties3.validate(
    (Void) null,
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of( Void.class, Map.class )

Method Summary

Modifier and Type	Method and Description
Void	validate(Void arg, SchemaConfiguration configuration)
AdditionalProperties3BoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
FrozenMap<String, @Nullable Object>	validate(Map<?, ?> arg, SchemaConfiguration configuration)
AdditionalProperties3BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
AdditionalProperties3Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

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

Files

NullableClass.md

Latest commit

History

NullableClass.md

File metadata and controls

NullableClass

Nested Class Summary

NullableClass1Boxed

NullableClass1BoxedMap

Constructor Summary

Method Summary

NullableClass1

Code Sample

Field Summary

Method Summary

NullableClassMapBuilder

Constructor Summary

Method Summary

NullableClassMap

Method Summary

ObjectItemsNullableBoxed

ObjectItemsNullableBoxedMap

Constructor Summary

Method Summary

ObjectItemsNullable

Code Sample

Field Summary

Method Summary

ObjectItemsNullableMapBuilder

Constructor Summary

Method Summary

ObjectItemsNullableMap

Method Summary

AdditionalProperties2Boxed

AdditionalProperties2BoxedVoid

Constructor Summary

Method Summary

AdditionalProperties2BoxedMap

Constructor Summary

Method Summary

AdditionalProperties2

Code Sample

Field Summary

Method Summary

ObjectAndItemsNullablePropBoxed

ObjectAndItemsNullablePropBoxedVoid

Constructor Summary

Method Summary

ObjectAndItemsNullablePropBoxedMap

Constructor Summary

Method Summary

ObjectAndItemsNullableProp

Code Sample

Field Summary

Method Summary

ObjectAndItemsNullablePropMapBuilder

Constructor Summary

Method Summary

ObjectAndItemsNullablePropMap

Method Summary

AdditionalProperties1Boxed

AdditionalProperties1BoxedVoid

Constructor Summary

Method Summary

AdditionalProperties1BoxedMap

Constructor Summary

Method Summary

AdditionalProperties1

Code Sample

Field Summary

Method Summary

ObjectNullablePropBoxed

ObjectNullablePropBoxedVoid

Constructor Summary

Method Summary

ObjectNullablePropBoxedMap

Constructor Summary

Method Summary

ObjectNullableProp