MyObjectDto.md

MyObjectDto

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

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	MyObjectDto.MyObjectDto1 schema class
static class	MyObjectDto.MyObjectDtoMapBuilder builder for Map payloads
static class	MyObjectDto.MyObjectDtoMap output class for Map payloads
static class	MyObjectDto.Id schema class
static class	MyObjectDto.AdditionalProperties schema class

MyObjectDto1

public static class MyObjectDto1
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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// Map validation
MyObjectDto.MyObjectDtoMap validatedPayload =
    MyObjectDto.MyObjectDto1.validate(
    new MyObjectDto.MyObjectDtoMapBuilder()
        .id("046b6c7f-0b8a-43b9-b35d-6489e6daee91")

    .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("id", Id.class)) )
Class<? extends JsonSchema>	additionalProperties = AdditionalProperties.class

Method Summary

Modifier and Type	Method and Description
MyObjectDtoMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

MyObjectDtoMapBuilder

public class MyObjectDtoMapBuilder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Map<String, String>	build() Returns map input that should be used with Schema.validate
MyObjectDtoMapBuilder	id(String value)

MyObjectDtoMap

public static class MyObjectDtoMap
extends FrozenMap<String, String>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static MyObjectDtoMap	of(Map<String, String> arg, SchemaConfiguration configuration)
String	id() [optional] value must be a uuid

Id

public static class Id
extends UuidJsonSchema

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.UuidJsonSchema
validate

AdditionalProperties

public static class AdditionalProperties
extends NotAnyTypeJsonSchema

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.NotAnyTypeJsonSchema
validate

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