NullableClass

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

A class that contains necessary nested schema classes, and classes to store validated list and map payloads

Nested Class Summary

Modifier and Type	Class and Description
static class	NullableClass.NullableClass1 schema class
static class	NullableClass.NullableClassMap output class for Map payloads
static class	NullableClass.ObjectItemsNullable schema class
static class	NullableClass.ObjectItemsNullableMap output class for Map payloads
static class	NullableClass.AdditionalProperties2 schema class
static class	NullableClass.ObjectAndItemsNullableProp schema class
static class	NullableClass.ObjectAndItemsNullablePropMap output class for Map payloads
static class	NullableClass.AdditionalProperties1 schema class
static class	NullableClass.ObjectNullableProp schema class
static class	NullableClass.ObjectNullablePropMap output class for Map payloads
static class	NullableClass.AdditionalProperties schema class
static class	NullableClass.ArrayItemsNullable schema class
static class	NullableClass.ArrayItemsNullableList output class for List payloads
static class	NullableClass.Items2 schema class
static class	NullableClass.ArrayAndItemsNullableProp schema class
static class	NullableClass.ArrayAndItemsNullablePropList output class for List payloads
static class	NullableClass.Items1 schema class
static class	NullableClass.ArrayNullableProp schema class
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.MapMaker;
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(
    MapMaker.makeMap(
        new AbstractMap.SimpleEntry<>(
            "integer_prop",
            (Void) null
        ),
        new AbstractMap.SimpleEntry<>(
            "number_prop",
            (Void) null
        ),
        new AbstractMap.SimpleEntry<>(
            "boolean_prop",
            (Void) null
        ),
        new AbstractMap.SimpleEntry<>(
            "string_prop",
            (Void) null
        ),
        new AbstractMap.SimpleEntry<>(
            "date_prop",
            (Void) null
        ),
        new AbstractMap.SimpleEntry<>(
            "datetime_prop",
            (Void) null
        ),
        new AbstractMap.SimpleEntry<>(
            "array_nullable_prop",
            (Void) null
        ),
        new AbstractMap.SimpleEntry<>(
            "array_and_items_nullable_prop",
            (Void) null
        ),
        new AbstractMap.SimpleEntry<>(
            "array_items_nullable",
            Arrays.asList(
                (Void) null
            )
        ),
        new AbstractMap.SimpleEntry<>(
            "object_nullable_prop",
            (Void) null
        ),
        new AbstractMap.SimpleEntry<>(
            "object_and_items_nullable_prop",
            (Void) null
        ),
        new AbstractMap.SimpleEntry<>(
            "object_items_nullable",
            MapMaker.makeMap(
            )
        )
    ),
    configuration
);

Field Summary

Modifier and Type

Field and Description

static LinkedHashMap<String, KeywordValidator>

keywordToValidator
new LinkedHashMap<>(Map.ofEntries(
    new KeywordEntry("type", new TypeValidator(Set.of(FrozenMap.class))),
    new KeywordEntry("properties", new PropertiesValidator(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))
    ))),
    new KeywordEntry("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties3.class))
));

Method Summary

Modifier and Type	Method and Description
static NullableClassMap	validate(Map<String, Object> arg, SchemaConfiguration configuration)

NullableClassMap

public static class NullableClassMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static NullableClassMap	of(Map<String, Object> arg, SchemaConfiguration configuration)
Long	integer_prop() [optional]
Number	number_prop() [optional]
Boolean	boolean_prop() [optional]
String	string_prop() [optional]
String	date_prop() [optional] value must conform to RFC-3339 full-date YYYY-MM-DD
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]
FrozenMap<String, Object>	getAdditionalProperty(String name) provides type safety for additional properties

Input Map Keys

type: Map<String, Object>

Key	Type	Description	Notes
integer_prop	Long		[optional]
number_prop	Number		[optional]
boolean_prop	Boolean		[optional]
string_prop	String		[optional]
date_prop	String		[optional] value must conform to RFC-3339 full-date YYYY-MM-DD
datetime_prop	String		[optional] value must conform to RFC-3339 date-time
array_nullable_prop	List<Map<String, Object>>		[optional]
array_and_items_nullable_prop	List<Map<String, Object>>		[optional]
array_items_nullable	List<Map<String, Object>>		[optional]
object_nullable_prop	Map<String, Map<String, Object>>		[optional]
object_and_items_nullable_prop	Map<String, Map<String, Object>>		[optional]
object_items_nullable	Map<String, Map<String, Object>>		[optional]
anyStringName	Map<String, Object>	any string name can be used but the value must be the correct type	[optional]

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.MapMaker;
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(
    MapMaker.makeMap(
    ),
    configuration
);

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of(FrozenMap.class))), new KeywordEntry("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties2.class)) ));

Method Summary

Modifier and Type	Method and Description
static ObjectItemsNullableMap	validate(Map<String, Map<String, Object>> arg, SchemaConfiguration configuration)

ObjectItemsNullableMap

public static class ObjectItemsNullableMap
extends FrozenMap<String, FrozenMap<String, Object>>

A class to store validated Map payloads

Method Summary

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

Input Map Keys

type: Map<String, Object>

Key	Type	Description	Notes
anyStringName	Map<String, Object>	any string name can be used but the value must be the correct type	[optional]

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.MapMaker;
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
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of( Void.class, FrozenMap.class ))) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static FrozenMap<String, Object>	validate(Map<String, 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.MapMaker;
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(
    MapMaker.makeMap(
    ),
    configuration
);

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of( Void.class, FrozenMap.class ))), new KeywordEntry("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties1.class)) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static ObjectAndItemsNullablePropMap	validate(Map<String, Map<String, Object>> arg, SchemaConfiguration configuration)

ObjectAndItemsNullablePropMap

public static class ObjectAndItemsNullablePropMap
extends FrozenMap<String, FrozenMap<String, Object>>

A class to store validated Map payloads

Method Summary

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

Input Map Keys

type: Map<String, Object>

Key	Type	Description	Notes
anyStringName	Map<String, Object>	any string name can be used but the value must be the correct type	[optional]

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.MapMaker;
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
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of( Void.class, FrozenMap.class ))) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static FrozenMap<String, Object>	validate(Map<String, 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.MapMaker;
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(
    MapMaker.makeMap(
    ),
    configuration
);

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of( Void.class, FrozenMap.class ))), new KeywordEntry("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties.class)) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static ObjectNullablePropMap	validate(Map<String, Map<String, Object>> arg, SchemaConfiguration configuration)

ObjectNullablePropMap

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

A class to store validated Map payloads

Method Summary

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

Input Map Keys

type: Map<String, Object>

Key	Type	Description	Notes
anyStringName	Map<String, Object>	any string name can be used but the value must be the correct type	[optional]

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.MapMaker;
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(
    Arrays.asList(
        (Void) null
    ),
    configuration
);

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of(FrozenList.class))), new KeywordEntry("items", new ItemsValidator(Items2.class)) ));

Method Summary

Modifier and Type	Method and Description
static ArrayItemsNullableList	validate(List<Map<String, Object>> arg, SchemaConfiguration configuration)

ArrayItemsNullableList

public class ArrayItemsNullableList
extends FrozenList<FrozenMap<String, Object>>

A class to store validated List payloads

Method Summary

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

Input List Items

type: List<Map<String, Object>>

List Item Type	Description	Notes
Map<String, Object>

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.MapMaker;
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
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of( Void.class, FrozenMap.class ))) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static FrozenMap<String, Object>	validate(Map<String, 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.MapMaker;
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(
    Arrays.asList(
        (Void) null
    ),
    configuration
);

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of( Void.class, FrozenList.class ))), new KeywordEntry("items", new ItemsValidator(Items1.class)) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static ArrayAndItemsNullablePropList	validate(List<Map<String, Object>> arg, SchemaConfiguration configuration)

ArrayAndItemsNullablePropList

public class ArrayAndItemsNullablePropList
extends FrozenList<FrozenMap<String, Object>>

A class to store validated List payloads

Method Summary

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

Input List Items

type: List<Map<String, Object>>

List Item Type	Description	Notes
Map<String, Object>

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.MapMaker;
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
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of( Void.class, FrozenMap.class ))) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static FrozenMap<String, Object>	validate(Map<String, 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.MapMaker;
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(
    Arrays.asList(
    ),
    configuration
);

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of( Void.class, FrozenList.class ))), new KeywordEntry("items", new ItemsValidator(Items.class)) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static ArrayNullablePropList	validate(List<Map<String, Object>> arg, SchemaConfiguration configuration)

ArrayNullablePropList

public class ArrayNullablePropList
extends FrozenList<FrozenMap<String, Object>>

A class to store validated List payloads

Method Summary

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

Input List Items

type: List<Map<String, Object>>

List Item Type	Description	Notes
Map<String, Object>

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.MapMaker;
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
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of( Void.class, String.class ))), new KeywordEntry("format", new FormatValidator("date-time")) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static String	validate(String 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.MapMaker;
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
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of( Void.class, String.class ))), new KeywordEntry("format", new FormatValidator("date")) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static String	validate(String 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.MapMaker;
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
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of( Void.class, String.class ))) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static String	validate(String 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.MapMaker;
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
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of( Void.class, Boolean.class ))) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static boolean	validate(boolean 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.MapMaker;
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
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of( Void.class, Integer.class, Long.class, Float.class, Double.class ))) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static Number	validate(Number 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.MapMaker;
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
);

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

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of( Void.class, Integer.class, Long.class, Float.class, Double.class ))) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static long	validate(long 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.MapMaker;
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
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries( new KeywordEntry("type", new TypeValidator(Set.of( Void.class, FrozenMap.class ))) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static FrozenMap<String, Object>	validate(Map<String, 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

NullableClassMap

Method Summary

Input Map Keys

ObjectItemsNullable

Code Sample

Field Summary

Method Summary

ObjectItemsNullableMap

Method Summary

Input Map Keys

AdditionalProperties2

Code Sample

Field Summary

Method Summary

ObjectAndItemsNullableProp

Code Sample

Field Summary

Method Summary

ObjectAndItemsNullablePropMap

Method Summary

Input Map Keys

AdditionalProperties1

Code Sample

Field Summary

Method Summary

ObjectNullableProp

Code Sample

Field Summary

Method Summary

ObjectNullablePropMap

Method Summary

Input Map Keys

AdditionalProperties

ArrayItemsNullable

Code Sample

Field Summary

Method Summary

ArrayItemsNullableList

Method Summary

Input List Items

Items2

Code Sample

Field Summary

Method Summary

ArrayAndItemsNullableProp

Code Sample

Field Summary

Method Summary

ArrayAndItemsNullablePropList

Method Summary

Input List Items

Items1

Code Sample

Field Summary

Method Summary

ArrayNullableProp

Code Sample

Field Summary

Method Summary

ArrayNullablePropList

Method Summary

Input List Items

Items

DatetimeProp

Code Sample

Field Summary

Method Summary

DateProp