ObjectModelWithArgAndArgsProperties.md

ObjectModelWithArgAndArgsProperties

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

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	ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsProperties1 schema class
static class	ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsPropertiesMap output class for Map payloads
static class	ObjectModelWithArgAndArgsProperties.Args schema class
static class	ObjectModelWithArgAndArgsProperties.Arg schema class

ObjectModelWithArgAndArgsProperties1

public static class ObjectModelWithArgAndArgsProperties1
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
ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsPropertiesMap validatedPayload =
    ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsProperties1.validate(
    MapMaker.makeMap(
        new AbstractMap.SimpleEntry<>(
            "arg",
            "a"
        ),
        new AbstractMap.SimpleEntry<>(
            "args",
            "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("arg", Arg.class)),         new PropertyEntry("args", Args.class))     ))),     new KeywordEntry("required", new RequiredValidator(Set.of(         "arg",         "args"     ))) ));

Method Summary

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

ObjectModelWithArgAndArgsPropertiesMap

public static class ObjectModelWithArgAndArgsPropertiesMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

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

Input Map Keys

type: Map<String, Object>

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

Args

public static class Args
extends StringJsonSchema

A schema class that validates payloads

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

Arg

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