ReadOnlyFirst.md

ReadOnlyFirst

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

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	ReadOnlyFirst.ReadOnlyFirst1 schema class
static class	ReadOnlyFirst.ReadOnlyFirstMap output class for Map payloads
static class	ReadOnlyFirst.Baz schema class
static class	ReadOnlyFirst.Bar schema class

ReadOnlyFirst1

public static class ReadOnlyFirst1
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
ReadOnlyFirst.ReadOnlyFirstMap validatedPayload =
    ReadOnlyFirst.ReadOnlyFirst1.validate(
    MapMaker.makeMap(
        new AbstractMap.SimpleEntry<>(
            "bar",
            "a"
        ),
        new AbstractMap.SimpleEntry<>(
            "baz",
            "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(FrozenMap.class))),     new KeywordEntry("properties", new PropertiesValidator(Map.ofEntries(         new PropertyEntry("bar", Bar.class)),         new PropertyEntry("baz", Baz.class))     ))) ));

Method Summary

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

ReadOnlyFirstMap

public static class ReadOnlyFirstMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

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

Input Map Keys

type: Map<String, Object>

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

Baz

public static class Baz
extends StringJsonSchema

A schema class that validates payloads

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

Bar

public static class Bar
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]