Address.md

Address

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

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	Address.Address1 schema class
static class	Address.AddressMapBuilder builder for Map payloads
static class	Address.AddressMap output class for Map payloads
static class	Address.AdditionalProperties schema class

Address1

public static class Address1
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
Address.AddressMap validatedPayload =
    Address.Address1.validate(
    new Address.AddressMapBuilder()
        .additionalProperty("someAdditionalProperty", 1)

    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(Map.class)
Class<? extends JsonSchema>	additionalProperties = AdditionalProperties.class

Method Summary

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

AddressMapBuilder

public class AddressMapBuilder
builder for Map<String, Number>

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Map<String, Number>	build() Returns map input that should be used with Schema.validate
AddressMapBuilder	additionalProperty(String key, int value)
AddressMapBuilder	additionalProperty(String key, float value)
AddressMapBuilder	additionalProperty(String key, long value)
AddressMapBuilder	additionalProperty(String key, double value)

AddressMap

public static class AddressMap
extends FrozenMap<String, Number>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static AddressMap	of(Map<String, Number> arg, SchemaConfiguration configuration)
Number	getAdditionalProperty(String name) provides type safety for additional properties

AdditionalProperties

public static class AdditionalProperties
extends IntJsonSchema

A schema class that validates payloads

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

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