FromSchema.md

FromSchema

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

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	FromSchema.FromSchema1 schema class
static class	FromSchema.FromSchemaMap output class for Map payloads
static class	FromSchema.Id schema class
static class	FromSchema.Data schema class

FromSchema1

public static class FromSchema1
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
FromSchema.FromSchemaMap validatedPayload =
    FromSchema.FromSchema1.validate(
    MapMaker.makeMap(
        new AbstractMap.SimpleEntry<>(
            "data",
            "a"
        ),
        new AbstractMap.SimpleEntry<>(
            "id",
            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(FrozenMap.class))),     new KeywordEntry("properties", new PropertiesValidator(Map.ofEntries(         new PropertyEntry("data", Data.class)),         new PropertyEntry("id", Id.class))     ))) ));

Method Summary

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

FromSchemaMap

public static class FromSchemaMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static FromSchemaMap	of(Map<String, Object> arg, SchemaConfiguration configuration)
String	data() [optional]
long	id() [optional]
Object	getAdditionalProperty(String name) provides type safety for additional properties

Input Map Keys

type: Map<String, Object>

Key	Type	Description	Notes
data	String		[optional]
id	long		[optional]
anyStringName	Object	any string name can be used but the value must be the correct type	[optional]

Id

public static class Id
extends IntJsonSchema

A schema class that validates payloads

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

Data

public static class Data
extends StringJsonSchema

A schema class that validates payloads

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

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