BasquePig.md

BasquePig

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

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	BasquePig.BasquePig1 schema class
static class	BasquePig.BasquePigMap output class for Map payloads
static class	BasquePig.ClassName schema class

BasquePig1

public static class BasquePig1
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
BasquePig.BasquePigMap validatedPayload =
    BasquePig.BasquePig1.validate(
    MapMaker.makeMap(
        new AbstractMap.SimpleEntry<>(
            "className",
            "BasquePig"
        )
    ),
    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("className", ClassName.class))     ))),     new KeywordEntry("required", new RequiredValidator(Set.of(         "className"     ))) ));

Method Summary

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

BasquePigMap

public static class BasquePigMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static BasquePigMap	of(Map<String, Object> arg, SchemaConfiguration configuration)
String	className() must be one of ["BasquePig"]
Object	getAdditionalProperty(String name) provides type safety for additional properties

Input Map Keys

type: Map<String, Object>

Key	Type	Description	Notes
className	String		must be one of ["BasquePig"]
anyStringName	Object	any string name can be used but the value must be the correct type	[optional]

ClassName

public static class ClassName
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());

// String validation
String validatedPayload = BasquePig.ClassName.validate(
    "BasquePig",
    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(         String.class     ))),     new KeywordEntry("enum", new EnumValidator(Set.of(         "BasquePig" ))) ));

Method Summary

Modifier and Type	Method and Description
static String	validate(String arg, SchemaConfiguration configuration)

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