SpecialModelname.md

SpecialModelname

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

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	SpecialModelname.SpecialModelname1Boxed sealed interface for validated payloads
record	SpecialModelname.SpecialModelname1BoxedMap boxed class to store validated Map payloads
static class	SpecialModelname.SpecialModelname1 schema class
static class	SpecialModelname.SpecialModelnameMapBuilder builder for Map payloads
static class	SpecialModelname.SpecialModelnameMap output class for Map payloads
sealed interface	SpecialModelname.ABoxed sealed interface for validated payloads
record	SpecialModelname.ABoxedString boxed class to store validated String payloads
static class	SpecialModelname.A schema class

SpecialModelname1Boxed

public sealed interface SpecialModelname1Boxed
permits
SpecialModelname1BoxedMap

sealed interface that stores validated payloads using boxed classes

SpecialModelname1BoxedMap

public record SpecialModelname1BoxedMap
implements SpecialModelname1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
SpecialModelname1BoxedMap(SpecialModelnameMap data) Creates an instance, private visibility

Method Summary

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

SpecialModelname1

public static class SpecialModelname1
extends JsonSchema

A schema class that validates payloads

Description

model with an invalid class name for python

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.validation.MapUtils;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;
import org.openapijsonschematools.client.components.schemas.SpecialModelname;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());

// Map validation
SpecialModelname.SpecialModelnameMap validatedPayload =
    SpecialModelname.SpecialModelname1.validate(
    new SpecialModelname.SpecialModelnameMapBuilder()
        .a("a")

    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(Map.class)
Map<String, Class<? extends JsonSchema>>	properties = Map.ofEntries(     new PropertyEntry("a", A.class)) )

Method Summary

Modifier and Type	Method and Description
SpecialModelnameMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
SpecialModelname1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
SpecialModelname1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

SpecialModelnameMapBuilder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
SpecialModelnameMapBuilder() 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
SpecialModelnameMapBuilder	a(String value)
SpecialModelnameMapBuilder	additionalProperty(String key, Void value)
SpecialModelnameMapBuilder	additionalProperty(String key, boolean value)
SpecialModelnameMapBuilder	additionalProperty(String key, String value)
SpecialModelnameMapBuilder	additionalProperty(String key, int value)
SpecialModelnameMapBuilder	additionalProperty(String key, float value)
SpecialModelnameMapBuilder	additionalProperty(String key, long value)
SpecialModelnameMapBuilder	additionalProperty(String key, double value)
SpecialModelnameMapBuilder	additionalProperty(String key, List<?> value)
SpecialModelnameMapBuilder	additionalProperty(String key, Map<String, ?> value)

SpecialModelnameMap

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

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static SpecialModelnameMap	of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
String	a() [optional]
@Nullable Object	getAdditionalProperty(String name) provides type safety for additional properties

ABoxed

public sealed interface ABoxed
permits
ABoxedString

sealed interface that stores validated payloads using boxed classes

ABoxedString

public record ABoxedString
implements ABoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

A

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