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
• sealed interfaces which store validated payloads, java version of a sum type
• boxed classes which store validated payloads, sealed permits class implementations
• classes to store validated map payloads, extends FrozenMap
• classes to build inputs for map payloads

Nested Class Summary

Modifier and Type	Class and Description
sealed interface	ClassModel.ClassModel1Boxed sealed interface for validated payloads
record	ClassModel.ClassModel1BoxedVoid boxed class to store validated null payloads
record	ClassModel.ClassModel1BoxedBoolean boxed class to store validated boolean payloads
record	ClassModel.ClassModel1BoxedNumber boxed class to store validated Number payloads
record	ClassModel.ClassModel1BoxedString boxed class to store validated String payloads
record	ClassModel.ClassModel1BoxedList boxed class to store validated List payloads
record	ClassModel.ClassModel1BoxedMap boxed class to store validated Map payloads
static class	ClassModel.ClassModel1 schema class
static class	ClassModel.ClassModelMapBuilder builder for Map payloads
static class	ClassModel.ClassModelMap output class for Map payloads
sealed interface	ClassModel.ClassSchemaBoxed sealed interface for validated payloads
record	ClassModel.ClassSchemaBoxedString boxed class to store validated String payloads
static class	ClassModel.ClassSchema schema class

ClassModel1Boxed

public sealed interface ClassModel1Boxed
permits
ClassModel1BoxedVoid, ClassModel1BoxedBoolean, ClassModel1BoxedNumber, ClassModel1BoxedString, ClassModel1BoxedList, ClassModel1BoxedMap

sealed interface that stores validated payloads using boxed classes

ClassModel1BoxedVoid

public record ClassModel1BoxedVoid
implements ClassModel1Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ClassModel1BoxedVoid(Void data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
Void	data() validated payload
@Nullable Object	getData() validated payload

ClassModel1BoxedBoolean

public record ClassModel1BoxedBoolean
implements ClassModel1Boxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ClassModel1BoxedBoolean(boolean data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
boolean	data() validated payload
@Nullable Object	getData() validated payload

ClassModel1BoxedNumber

public record ClassModel1BoxedNumber
implements ClassModel1Boxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ClassModel1BoxedNumber(Number data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
Number	data() validated payload
@Nullable Object	getData() validated payload

ClassModel1BoxedString

public record ClassModel1BoxedString
implements ClassModel1Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ClassModel1BoxedString(String data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
String	data() validated payload
@Nullable Object	getData() validated payload

ClassModel1BoxedList

public record ClassModel1BoxedList
implements ClassModel1Boxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ClassModel1BoxedList(FrozenList<@Nullable Object> data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
FrozenList<@Nullable Object>	data() validated payload
@Nullable Object	getData() validated payload

ClassModel1BoxedMap

public record ClassModel1BoxedMap
implements ClassModel1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ClassModel1BoxedMap(ClassModelMap data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
ClassModelMap	data() validated payload
@Nullable Object	getData() validated payload

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)
Number	validate(Number arg, SchemaConfiguration configuration)
boolean	validate(boolean arg, SchemaConfiguration configuration)
ClassModelMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object>	validate(List<?> arg, SchemaConfiguration configuration)
ClassModel1BoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
ClassModel1BoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
ClassModel1BoxedNumber	validateAndBox(Number arg, SchemaConfiguration configuration)
ClassModel1BoxedBoolean	validateAndBox(boolean arg, SchemaConfiguration configuration)
ClassModel1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
ClassModel1BoxedList	validateAndBox(List<?> arg, SchemaConfiguration configuration)
ClassModel1Boxed	validateAndBox(@Nullable Object 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	lowLineClass(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

ClassSchemaBoxed

public sealed interface ClassSchemaBoxed
permits
ClassSchemaBoxedString

sealed interface that stores validated payloads using boxed classes

ClassSchemaBoxedString

public record ClassSchemaBoxedString
implements ClassSchemaBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ClassSchemaBoxedString(String data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
String	data() validated payload
@Nullable Object	getData() validated payload

ClassSchema

public static class ClassSchema
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

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

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