ClassModel.md

ClassModel

org.openapijsonschematools.components.schemas.ClassModel.java public class ClassModel

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	ClassModel.ClassModel1 schema class
static class	ClassModel.ClassModelMap output class for Map payloads
static class	ClassModel.ClassSchema schema class

ClassModel1

public static class ClassModel1
extends JsonSchema

A schema class that validates payloads

Description

Model for testing model with "_class" property

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries(     new KeywordEntry("properties", new PropertiesValidator(Map.ofEntries(         new PropertyEntry("_class", ClassSchema.class))     ))) ));

Method Summary

Modifier and Type	Method and Description
static String	validate(String arg, SchemaConfiguration configuration)
static Void	validate(Void arg, SchemaConfiguration configuration)
static int	validate(int arg, SchemaConfiguration configuration)
static long	validate(long arg, SchemaConfiguration configuration)
static float	validate(float arg, SchemaConfiguration configuration)
static double	validate(double arg, SchemaConfiguration configuration)
static boolean	validate(boolean arg, SchemaConfiguration configuration)
static ClassModelMap	validate(Map<String, Object> arg, SchemaConfiguration configuration)
FrozenList	validate(List arg, SchemaConfiguration configuration)

ClassModelMap

public static class ClassModelMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static ClassModelMap	of(Map<String, Object> arg, SchemaConfiguration configuration)
Object	get(String key) This schema has invalid Java names so this method must be used when you access instance["_class"],
Object	getAdditionalProperty(String name) provides type safety for additional properties

Input Map Keys

type: Map<String, Object>

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

ClassSchema

public static class ClassSchema
extends StringJsonSchema

A schema class that validates payloads

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

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