AnimalFarm.md

AnimalFarm

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

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	AnimalFarm.AnimalFarm1 schema class
static class	AnimalFarm.AnimalFarmList output class for List payloads

AnimalFarm1

public static class AnimalFarm1
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
AnimalFarm.AnimalFarmList validatedPayload =
    AnimalFarm.AnimalFarm1.validate(
    Arrays.asList(
        MapMaker.makeMap(
            new AbstractMap.SimpleEntry<>(
                "className",
                "a"
            ),
            new AbstractMap.SimpleEntry<>(
                "color",
                "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(FrozenList.class))),     new KeywordEntry("items", new ItemsValidator(Animal.Animal1.class) ));

Method Summary

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

AnimalFarmList

public class AnimalFarmList
extends FrozenList<Animal.AnimalMap>

A class to store validated List payloads

Method Summary

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

Input List Items

type: List<Map<String, Object>>

List Item Type	Description	Notes
Map<String, Object>

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