NullableClass

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

A class that contains necessary nested

schema classes (which validate payloads), extends JsonSchema
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
static class	NullableClass.NullableClass1 schema class
static class	NullableClass.NullableClassMapBuilder builder for Map payloads
static class	NullableClass.NullableClassMap output class for 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
static class	NullableClass.AdditionalProperties2 schema class
static class	NullableClass.ObjectAndItemsNullableProp schema class
static class	NullableClass.ObjectAndItemsNullablePropMapBuilder builder for Map payloads
static class	NullableClass.ObjectAndItemsNullablePropMap output class for Map payloads
static class	NullableClass.AdditionalProperties1 schema class
static class	NullableClass.ObjectNullableProp schema class
static class	NullableClass.ObjectNullablePropMapBuilder builder for Map payloads
static class	NullableClass.ObjectNullablePropMap output class for Map payloads
static class	NullableClass.AdditionalProperties schema class
static class	NullableClass.ArrayItemsNullable schema class
static class	NullableClass.ArrayItemsNullableListBuilder builder for List payloads
static class	NullableClass.ArrayItemsNullableList output class for List payloads
static class	NullableClass.Items2 schema class
static class	NullableClass.ArrayAndItemsNullableProp schema class
static class	NullableClass.ArrayAndItemsNullablePropListBuilder builder for List payloads
static class	NullableClass.ArrayAndItemsNullablePropList output class for List payloads
static class	NullableClass.Items1 schema class
static class	NullableClass.ArrayNullableProp schema class
static class	NullableClass.ArrayNullablePropListBuilder builder for List payloads
static class	NullableClass.ArrayNullablePropList output class for List payloads
static class	NullableClass.Items schema class
static class	NullableClass.DatetimeProp schema class
static class	NullableClass.DateProp schema class
static class	NullableClass.StringProp schema class
static class	NullableClass.BooleanProp schema class
static class	NullableClass.NumberProp schema class
static class	NullableClass.IntegerProp schema class
static class	NullableClass.AdditionalProperties3 schema class

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
@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

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
@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

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
FrozenMap<String, @Nullable Object>	validate(Map<?, ?> arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
ObjectAndItemsNullablePropMap	validate(Map<?, ?> 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

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
FrozenMap<String, @Nullable Object>	validate(Map<?, ?> arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
ObjectNullablePropMap	validate(Map<?, ?> 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

AdditionalProperties

public static class AdditionalProperties
extends MapJsonSchema

A schema class that validates payloads

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

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
@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)

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
FrozenMap<String, @Nullable Object>	validate(Map<?, ?> arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
ArrayAndItemsNullablePropList	validate(List<?> 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)

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
FrozenMap<String, @Nullable Object>	validate(Map<?, ?> arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
ArrayNullablePropList	validate(List<?> 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)

Items

public static class Items
extends MapJsonSchema

A schema class that validates payloads

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

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
String	validate(String arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
String	validate(String arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
String	validate(String arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
boolean	validate(boolean arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
Number	validate(Number arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
long	validate(long arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
FrozenMap<String, @Nullable Object>	validate(Map<?, ?> 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

NullableClass1

Code Sample

Field Summary

Method Summary

NullableClassMapBuilder

Constructor Summary

Method Summary

NullableClassMap

Method Summary

ObjectItemsNullable

Code Sample

Field Summary

Method Summary

ObjectItemsNullableMapBuilder

Constructor Summary

Method Summary

ObjectItemsNullableMap

Method Summary

AdditionalProperties2

Code Sample

Field Summary

Method Summary

ObjectAndItemsNullableProp

Code Sample

Field Summary

Method Summary

ObjectAndItemsNullablePropMapBuilder

Constructor Summary

Method Summary

ObjectAndItemsNullablePropMap

Method Summary

AdditionalProperties1

Code Sample

Field Summary

Method Summary

ObjectNullableProp

Code Sample

Field Summary

Method Summary

ObjectNullablePropMapBuilder

Constructor Summary

Method Summary

ObjectNullablePropMap

Method Summary

AdditionalProperties

ArrayItemsNullable

Code Sample

Field Summary

Method Summary

ArrayItemsNullableListBuilder

Constructor Summary

Method Summary

ArrayItemsNullableList

Method Summary

Items2

Code Sample

Field Summary

Method Summary

ArrayAndItemsNullableProp

Code Sample

Field Summary

Method Summary

ArrayAndItemsNullablePropListBuilder

Constructor Summary

Method Summary

ArrayAndItemsNullablePropList

Method Summary

Items1

Code Sample

Field Summary

Method Summary

ArrayNullableProp