ClassModel.md

ClassModel

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

A class that contains necessary nested

• schema classes (which validate payloads), extends JsonSchema
• classes to store validated map payloads, extends FrozenMap
• classes to build inputs for map payloads

Nested Class Summary

Modifier and Type	Class and Description
static class	ClassModel.ClassModel1 schema class
static class	ClassModel.ClassModelMapBuilder builder for Map payloads
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
Map<String, Class<? extends JsonSchema>>	properties = Map.ofEntries(     new PropertyEntry("_class", ClassSchema.class)) )

Method Summary

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

ClassModelMapBuilder

public class ClassModelMapBuilder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
ClassModelMapBuilder() Creates a builder that contains an empty map

Method Summary

Modifier and Type	Method and Description
Map<String, @Nullable Object>	build() Returns map input that should be used with Schema.validate
ClassModelMapBuilder	setClass(String value)
ClassModelMapBuilder	additionalProperty(String key, Void value)
ClassModelMapBuilder	additionalProperty(String key, boolean value)
ClassModelMapBuilder	additionalProperty(String key, String value)
ClassModelMapBuilder	additionalProperty(String key, int value)
ClassModelMapBuilder	additionalProperty(String key, float value)
ClassModelMapBuilder	additionalProperty(String key, long value)
ClassModelMapBuilder	additionalProperty(String key, double value)
ClassModelMapBuilder	additionalProperty(String key, List<?> value)
ClassModelMapBuilder	additionalProperty(String key, Map<String, ?> value)

ClassModelMap

public static class ClassModelMap
extends FrozenMap<String, @Nullable Object>

A class to store validated Map payloads

Method Summary

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

ClassSchema

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