ObjWithRequiredProps.md

ObjWithRequiredProps

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

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	ObjWithRequiredProps.ObjWithRequiredProps1Boxed sealed interface for validated payloads
record	ObjWithRequiredProps.ObjWithRequiredProps1BoxedMap boxed class to store validated Map payloads
static class	ObjWithRequiredProps.ObjWithRequiredProps1 schema class
static class	ObjWithRequiredProps.ObjWithRequiredPropsMapBuilder builder for Map payloads
static class	ObjWithRequiredProps.ObjWithRequiredPropsMap output class for Map payloads
sealed interface	ObjWithRequiredProps.ABoxed sealed interface for validated payloads
record	ObjWithRequiredProps.ABoxedString boxed class to store validated String payloads
static class	ObjWithRequiredProps.A schema class

ObjWithRequiredProps1Boxed

public sealed interface ObjWithRequiredProps1Boxed
permits
ObjWithRequiredProps1BoxedMap

sealed interface that stores validated payloads using boxed classes

ObjWithRequiredProps1BoxedMap

public record ObjWithRequiredProps1BoxedMap
implements ObjWithRequiredProps1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ObjWithRequiredProps1BoxedMap(ObjWithRequiredPropsMap data) Creates an instance, private visibility

Method Summary

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

ObjWithRequiredProps1

public static class ObjWithRequiredProps1
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.validation.MapUtils;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;
import org.openapijsonschematools.client.components.schemas.ObjWithRequiredProps;

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

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

// Map validation
ObjWithRequiredProps.ObjWithRequiredPropsMap validatedPayload =
    ObjWithRequiredProps.ObjWithRequiredProps1.validate(
    new ObjWithRequiredProps.ObjWithRequiredPropsMapBuilder()
        .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)) )
Set	required = Set.of(     "a" )
List<Class<? extends JsonSchema>>	allOf = List.of(     ObjWithRequiredPropsBase.ObjWithRequiredPropsBase1.class ;)

Method Summary

Modifier and Type	Method and Description
ObjWithRequiredPropsMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
ObjWithRequiredProps1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
ObjWithRequiredProps1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ObjWithRequiredPropsMap0Builder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
ObjWithRequiredPropsMap0Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

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

ObjWithRequiredPropsMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
ObjWithRequiredPropsMap0Builder	a(String value)

ObjWithRequiredPropsMap

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

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static ObjWithRequiredPropsMap	of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
String	a()
@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]