Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Latest commit

 

History

History
706 lines (577 loc) · 34.1 KB

AdditionalPropertiesClass.md

File metadata and controls

706 lines (577 loc) · 34.1 KB

AdditionalPropertiesClass

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

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 AdditionalPropertiesClass.AdditionalPropertiesClass1
schema class
static class AdditionalPropertiesClass.AdditionalPropertiesClassMapBuilder
builder for Map payloads
static class AdditionalPropertiesClass.AdditionalPropertiesClassMap
output class for Map payloads
static class AdditionalPropertiesClass.MapWithUndeclaredPropertiesString
schema class
static class AdditionalPropertiesClass.MapWithUndeclaredPropertiesStringMapBuilder
builder for Map payloads
static class AdditionalPropertiesClass.MapWithUndeclaredPropertiesStringMap
output class for Map payloads
static class AdditionalPropertiesClass.AdditionalProperties5
schema class
static class AdditionalPropertiesClass.EmptyMap
schema class
static class AdditionalPropertiesClass.EmptyMapMapBuilder
builder for Map payloads
static class AdditionalPropertiesClass.EmptyMapMap
output class for Map payloads
static class AdditionalPropertiesClass.AdditionalProperties4
schema class
static class AdditionalPropertiesClass.MapWithUndeclaredPropertiesAnytype3
schema class
static class AdditionalPropertiesClass.MapWithUndeclaredPropertiesAnytype3MapBuilder
builder for Map payloads
static class AdditionalPropertiesClass.MapWithUndeclaredPropertiesAnytype3Map
output class for Map payloads
static class AdditionalPropertiesClass.AdditionalProperties3
schema class
static class AdditionalPropertiesClass.MapWithUndeclaredPropertiesAnytype2
schema class
static class AdditionalPropertiesClass.MapWithUndeclaredPropertiesAnytype1
schema class
static class AdditionalPropertiesClass.Anytype1
schema class
static class AdditionalPropertiesClass.MapOfMapProperty
schema class
static class AdditionalPropertiesClass.MapOfMapPropertyMapBuilder
builder for Map payloads
static class AdditionalPropertiesClass.MapOfMapPropertyMap
output class for Map payloads
static class AdditionalPropertiesClass.AdditionalProperties1
schema class
static class AdditionalPropertiesClass.AdditionalPropertiesMapBuilder2
builder for Map payloads
static class AdditionalPropertiesClass.AdditionalPropertiesMap
output class for Map payloads
static class AdditionalPropertiesClass.AdditionalProperties2
schema class
static class AdditionalPropertiesClass.MapProperty
schema class
static class AdditionalPropertiesClass.MapPropertyMapBuilder
builder for Map payloads
static class AdditionalPropertiesClass.MapPropertyMap
output class for Map payloads
static class AdditionalPropertiesClass.AdditionalProperties
schema class

AdditionalPropertiesClass1

public static class AdditionalPropertiesClass1
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
AdditionalPropertiesClass.AdditionalPropertiesClassMap validatedPayload =
    AdditionalPropertiesClass.AdditionalPropertiesClass1.validate(
    new AdditionalPropertiesClass.AdditionalPropertiesClassMapBuilder()
        .map_property(
            MapUtils.makeMap(
                new AbstractMap.SimpleEntry<>(
                    "someAdditionalProperty",
                    "a"
                )
            )
        )
        .map_of_map_property(
            MapUtils.makeMap(
                new AbstractMap.SimpleEntry<>(
                    "someAdditionalProperty",
                    MapUtils.makeMap(
                        new AbstractMap.SimpleEntry<>(
                            "someAdditionalProperty",
                            "a"
                        )
                    )
                )
            )
        )
        .map_with_undeclared_properties_anytype_3(
            MapUtils.makeMap(
            )
        )
        .empty_map(
            MapUtils.makeMap(
            )
        )
        .map_with_undeclared_properties_string(
            MapUtils.makeMap(
                new AbstractMap.SimpleEntry<>(
                    "someAdditionalProperty",
                    "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("map_property", MapProperty.class)),
    new PropertyEntry("map_of_map_property", MapOfMapProperty.class)),
    new PropertyEntry("anytype_1", Anytype1.class)),
    new PropertyEntry("map_with_undeclared_properties_anytype_1", MapWithUndeclaredPropertiesAnytype1.class)),
    new PropertyEntry("map_with_undeclared_properties_anytype_2", MapWithUndeclaredPropertiesAnytype2.class)),
    new PropertyEntry("map_with_undeclared_properties_anytype_3", MapWithUndeclaredPropertiesAnytype3.class)),
    new PropertyEntry("empty_map", EmptyMap.class)),
    new PropertyEntry("map_with_undeclared_properties_string", MapWithUndeclaredPropertiesString.class))
)

Method Summary

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

AdditionalPropertiesClassMapBuilder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
AdditionalPropertiesClassMapBuilder()
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
AdditionalPropertiesClassMapBuilder map_property(Map<String, String> value)
AdditionalPropertiesClassMapBuilder map_of_map_property(Map<String, Map<String, String>> value)
AdditionalPropertiesClassMapBuilder anytype_1(Void value)
AdditionalPropertiesClassMapBuilder anytype_1(boolean value)
AdditionalPropertiesClassMapBuilder anytype_1(String value)
AdditionalPropertiesClassMapBuilder anytype_1(int value)
AdditionalPropertiesClassMapBuilder anytype_1(float value)
AdditionalPropertiesClassMapBuilder anytype_1(long value)
AdditionalPropertiesClassMapBuilder anytype_1(double value)
AdditionalPropertiesClassMapBuilder anytype_1(List<?> value)
AdditionalPropertiesClassMapBuilder anytype_1(Map<String, ?> value)
AdditionalPropertiesClassMapBuilder map_with_undeclared_properties_anytype_1(Map<String, @Nullable Object> value)
AdditionalPropertiesClassMapBuilder map_with_undeclared_properties_anytype_2(Map<String, @Nullable Object> value)
AdditionalPropertiesClassMapBuilder map_with_undeclared_properties_anytype_3(Map<String, @Nullable Object> value)
AdditionalPropertiesClassMapBuilder empty_map(Map<String, @Nullable Object> value)
AdditionalPropertiesClassMapBuilder map_with_undeclared_properties_string(Map<String, String> value)
AdditionalPropertiesClassMapBuilder additionalProperty(String key, Void value)
AdditionalPropertiesClassMapBuilder additionalProperty(String key, boolean value)
AdditionalPropertiesClassMapBuilder additionalProperty(String key, String value)
AdditionalPropertiesClassMapBuilder additionalProperty(String key, int value)
AdditionalPropertiesClassMapBuilder additionalProperty(String key, float value)
AdditionalPropertiesClassMapBuilder additionalProperty(String key, long value)
AdditionalPropertiesClassMapBuilder additionalProperty(String key, double value)
AdditionalPropertiesClassMapBuilder additionalProperty(String key, List<?> value)
AdditionalPropertiesClassMapBuilder additionalProperty(String key, Map<String, ?> value)

AdditionalPropertiesClassMap

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

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static AdditionalPropertiesClassMap of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
MapPropertyMap map_property()
[optional]
MapOfMapPropertyMap map_of_map_property()
[optional]
@Nullable Object anytype_1()
[optional]
FrozenMap<?> map_with_undeclared_properties_anytype_1()
[optional]
FrozenMap<?> map_with_undeclared_properties_anytype_2()
[optional]
MapWithUndeclaredPropertiesAnytype3Map map_with_undeclared_properties_anytype_3()
[optional]
EmptyMapMap empty_map()
[optional]
MapWithUndeclaredPropertiesStringMap map_with_undeclared_properties_string()
[optional]
@Nullable Object getAdditionalProperty(String name)
provides type safety for additional properties

MapWithUndeclaredPropertiesString

public static class MapWithUndeclaredPropertiesString
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
AdditionalPropertiesClass.MapWithUndeclaredPropertiesStringMap validatedPayload =
    AdditionalPropertiesClass.MapWithUndeclaredPropertiesString.validate(
    new AdditionalPropertiesClass.MapWithUndeclaredPropertiesStringMapBuilder()
        .additionalProperty("someAdditionalProperty", "a")

    .build(),
    configuration
);

Field Summary

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

Method Summary

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

MapWithUndeclaredPropertiesStringMapBuilder

public class MapWithUndeclaredPropertiesStringMapBuilder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
MapWithUndeclaredPropertiesStringMapBuilder()
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
MapWithUndeclaredPropertiesStringMapBuilder additionalProperty(String key, String value)

MapWithUndeclaredPropertiesStringMap

public static class MapWithUndeclaredPropertiesStringMap
extends FrozenMap<String, String>

A class to store validated Map payloads

Method Summary

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

AdditionalProperties5

public static class AdditionalProperties5
extends StringJsonSchema

A schema class that validates payloads

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

EmptyMap

public static class EmptyMap
extends JsonSchema

A schema class that validates payloads

Description

an object with no declared properties and no undeclared properties, hence it's an empty map.

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
AdditionalPropertiesClass.EmptyMapMap validatedPayload =
    AdditionalPropertiesClass.EmptyMap.validate(
    new AdditionalPropertiesClass.EmptyMapMapBuilder()
    .build(),
    configuration
);

Field Summary

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

Method Summary

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

EmptyMapMapBuilder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
EmptyMapMapBuilder()
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

EmptyMapMap

public static class EmptyMapMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static EmptyMapMap of(Map<String, Object> arg, SchemaConfiguration configuration)

AdditionalProperties4

public static class AdditionalProperties4
extends NotAnyTypeJsonSchema

A schema class that validates payloads

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

MapWithUndeclaredPropertiesAnytype3

public static class MapWithUndeclaredPropertiesAnytype3
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
AdditionalPropertiesClass.MapWithUndeclaredPropertiesAnytype3Map validatedPayload =
    AdditionalPropertiesClass.MapWithUndeclaredPropertiesAnytype3.validate(
    new AdditionalPropertiesClass.MapWithUndeclaredPropertiesAnytype3MapBuilder()
    .build(),
    configuration
);

Field Summary

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

Method Summary

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

MapWithUndeclaredPropertiesAnytype3MapBuilder

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

A class that builds the Map input type

Constructor Summary

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

MapWithUndeclaredPropertiesAnytype3Map

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

A class to store validated Map payloads

Method Summary

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

AdditionalProperties3

public static class AdditionalProperties3
extends AnyTypeJsonSchema

A schema class that validates payloads

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

MapWithUndeclaredPropertiesAnytype2

public static class MapWithUndeclaredPropertiesAnytype2
extends MapJsonSchema

A schema class that validates payloads

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

MapWithUndeclaredPropertiesAnytype1

public static class MapWithUndeclaredPropertiesAnytype1
extends MapJsonSchema

A schema class that validates payloads

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

Anytype1

public static class Anytype1
extends AnyTypeJsonSchema

A schema class that validates payloads

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

MapOfMapProperty

public static class MapOfMapProperty
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
AdditionalPropertiesClass.MapOfMapPropertyMap validatedPayload =
    AdditionalPropertiesClass.MapOfMapProperty.validate(
    new AdditionalPropertiesClass.MapOfMapPropertyMapBuilder()
        .additionalProperty(
            "someAdditionalProperty",
            MapUtils.makeMap(
                new AbstractMap.SimpleEntry<>(
                    "someAdditionalProperty",
                    "a"
                )
            )
        )
    .build(),
    configuration
);

Field Summary

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

Method Summary

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

MapOfMapPropertyMapBuilder

public class MapOfMapPropertyMapBuilder
builder for Map<String, Map<String, String>>

A class that builds the Map input type

Constructor Summary

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

Method Summary

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

MapOfMapPropertyMap

public static class MapOfMapPropertyMap
extends FrozenMap<String, AdditionalPropertiesMap>

A class to store validated Map payloads

Method Summary

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

AdditionalProperties1

public static class AdditionalProperties1
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
AdditionalPropertiesClass.AdditionalPropertiesMap validatedPayload =
    AdditionalPropertiesClass.AdditionalProperties1.validate(
    new AdditionalPropertiesClass.AdditionalPropertiesMapBuilder2()
        .additionalProperty("someAdditionalProperty", "a")

    .build(),
    configuration
);

Field Summary

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

Method Summary

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

AdditionalPropertiesMapBuilder2

public class AdditionalPropertiesMapBuilder2
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
AdditionalPropertiesMapBuilder2()
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
AdditionalPropertiesMapBuilder2 additionalProperty(String key, String value)

AdditionalPropertiesMap

public static class AdditionalPropertiesMap
extends FrozenMap<String, String>

A class to store validated Map payloads

Method Summary

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

AdditionalProperties2

public static class AdditionalProperties2
extends StringJsonSchema

A schema class that validates payloads

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

MapProperty

public static class MapProperty
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
AdditionalPropertiesClass.MapPropertyMap validatedPayload =
    AdditionalPropertiesClass.MapProperty.validate(
    new AdditionalPropertiesClass.MapPropertyMapBuilder()
        .additionalProperty("someAdditionalProperty", "a")

    .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
MapPropertyMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

MapPropertyMapBuilder

public class MapPropertyMapBuilder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
MapPropertyMapBuilder()
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
MapPropertyMapBuilder additionalProperty(String key, String value)

MapPropertyMap

public static class MapPropertyMap
extends FrozenMap<String, String>

A class to store validated Map payloads

Method Summary

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

AdditionalProperties

public static class AdditionalProperties
extends StringJsonSchema

A schema class that validates payloads

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

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