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

MapTest.md

Latest commit

 

History

History
753 lines (607 loc) · 32.5 KB

MapTest.md

File metadata and controls

753 lines (607 loc) · 32.5 KB

MapTest

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

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
  • enum classes

Nested Class Summary

Modifier and Type Class and Description
sealed interface MapTest.MapTest1Boxed
sealed interface for validated payloads
record MapTest.MapTest1BoxedMap
boxed class to store validated Map payloads
static class MapTest.MapTest1
schema class
static class MapTest.MapTestMapBuilder
builder for Map payloads
static class MapTest.MapTestMap
output class for Map payloads
sealed interface MapTest.DirectMapBoxed
sealed interface for validated payloads
record MapTest.DirectMapBoxedMap
boxed class to store validated Map payloads
static class MapTest.DirectMap
schema class
static class MapTest.DirectMapMapBuilder
builder for Map payloads
static class MapTest.DirectMapMap
output class for Map payloads
sealed interface MapTest.AdditionalProperties3Boxed
sealed interface for validated payloads
record MapTest.AdditionalProperties3BoxedBoolean
boxed class to store validated boolean payloads
static class MapTest.AdditionalProperties3
schema class
sealed interface MapTest.MapOfEnumStringBoxed
sealed interface for validated payloads
record MapTest.MapOfEnumStringBoxedMap
boxed class to store validated Map payloads
static class MapTest.MapOfEnumString
schema class
static class MapTest.MapOfEnumStringMapBuilder
builder for Map payloads
static class MapTest.MapOfEnumStringMap
output class for Map payloads
sealed interface MapTest.AdditionalProperties2Boxed
sealed interface for validated payloads
record MapTest.AdditionalProperties2BoxedString
boxed class to store validated String payloads
static class MapTest.AdditionalProperties2
schema class
enum MapTest.StringAdditionalPropertiesEnums
String enum
sealed interface MapTest.MapMapOfStringBoxed
sealed interface for validated payloads
record MapTest.MapMapOfStringBoxedMap
boxed class to store validated Map payloads
static class MapTest.MapMapOfString
schema class
static class MapTest.MapMapOfStringMapBuilder
builder for Map payloads
static class MapTest.MapMapOfStringMap
output class for Map payloads
sealed interface MapTest.AdditionalPropertiesBoxed
sealed interface for validated payloads
record MapTest.AdditionalPropertiesBoxedMap
boxed class to store validated Map payloads
static class MapTest.AdditionalProperties
schema class
static class MapTest.AdditionalPropertiesMapBuilder1
builder for Map payloads
static class MapTest.AdditionalPropertiesMap
output class for Map payloads
sealed interface MapTest.AdditionalProperties1Boxed
sealed interface for validated payloads
record MapTest.AdditionalProperties1BoxedString
boxed class to store validated String payloads
static class MapTest.AdditionalProperties1
schema class

MapTest1Boxed

public sealed interface MapTest1Boxed
permits
MapTest1BoxedMap

sealed interface that stores validated payloads using boxed classes

MapTest1BoxedMap

public record MapTest1BoxedMap
implements MapTest1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
MapTest1BoxedMap(MapTestMap data)
Creates an instance, private visibility

Method Summary

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

MapTest1

public static class MapTest1
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.MapTest;

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

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

// Map validation
MapTest.MapTestMap validatedPayload =
    MapTest.MapTest1.validate(
    new MapTest.MapTestMapBuilder()
        .map_map_of_string(
            MapUtils.makeMap(
                new AbstractMap.SimpleEntry<String, Map<String, ?>>(
                    "someAdditionalProperty",
                    MapUtils.makeMap(
                        new AbstractMap.SimpleEntry<String, String>(
                            "someAdditionalProperty",
                            "a"
                        )
                    )
                )
            )
        )
        .map_of_enum_string(
            MapUtils.makeMap(
                new AbstractMap.SimpleEntry<String, String>(
                    "someAdditionalProperty",
                    "UPPER"
                )
            )
        )
        .direct_map(
            MapUtils.makeMap(
                new AbstractMap.SimpleEntry<String, Boolean>(
                    "someAdditionalProperty",
                    true
                )
            )
        )
    .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_map_of_string", MapMapOfString.class)),
    new PropertyEntry("map_of_enum_string", MapOfEnumString.class)),
    new PropertyEntry("direct_map", DirectMap.class)),
    new PropertyEntry("indirect_map", StringBooleanMap.StringBooleanMap1.class)
)

Method Summary

Modifier and Type Method and Description
MapTestMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
MapTest1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
MapTest1Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

MapTestMapBuilder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
MapTestMapBuilder()
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
MapTestMapBuilder map_map_of_string(Map<String, Map<String, String>> value)
MapTestMapBuilder map_of_enum_string(Map<String, String> value)
MapTestMapBuilder direct_map(Map<String, Boolean> value)
MapTestMapBuilder indirect_map(Map<String, Boolean> value)
MapTestMapBuilder additionalProperty(String key, Void value)
MapTestMapBuilder additionalProperty(String key, boolean value)
MapTestMapBuilder additionalProperty(String key, String value)
MapTestMapBuilder additionalProperty(String key, int value)
MapTestMapBuilder additionalProperty(String key, float value)
MapTestMapBuilder additionalProperty(String key, long value)
MapTestMapBuilder additionalProperty(String key, double value)
MapTestMapBuilder additionalProperty(String key, List<?> value)
MapTestMapBuilder additionalProperty(String key, Map<String, ?> value)

MapTestMap

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

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static MapTestMap of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
MapMapOfStringMap map_map_of_string()
[optional]
MapOfEnumStringMap map_of_enum_string()
[optional]
DirectMapMap direct_map()
[optional]
StringBooleanMap.StringBooleanMapMap indirect_map()
[optional]
@Nullable Object getAdditionalProperty(String name)
provides type safety for additional properties

DirectMapBoxed

public sealed interface DirectMapBoxed
permits
DirectMapBoxedMap

sealed interface that stores validated payloads using boxed classes

DirectMapBoxedMap

public record DirectMapBoxedMap
implements DirectMapBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
DirectMapBoxedMap(DirectMapMap data)
Creates an instance, private visibility

Method Summary

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

DirectMap

public static class DirectMap
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.MapTest;

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

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

// Map validation
MapTest.DirectMapMap validatedPayload =
    MapTest.DirectMap.validate(
    new MapTest.DirectMapMapBuilder()
        .additionalProperty("someAdditionalProperty", true)

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

DirectMapMapBuilder

public class DirectMapMapBuilder
builder for Map<String, Boolean>

A class that builds the Map input type

Constructor Summary

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

Method Summary

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

DirectMapMap

public static class DirectMapMap
extends FrozenMap<String, Boolean>

A class to store validated Map payloads

Method Summary

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

AdditionalProperties3Boxed

public sealed interface AdditionalProperties3Boxed
permits
AdditionalProperties3BoxedBoolean

sealed interface that stores validated payloads using boxed classes

AdditionalProperties3BoxedBoolean

public record AdditionalProperties3BoxedBoolean
implements AdditionalProperties3Boxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalProperties3BoxedBoolean(boolean data)
Creates an instance, private visibility

Method Summary

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

AdditionalProperties3

public static class AdditionalProperties3
extends BooleanJsonSchema.BooleanJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.BooleanJsonSchema.BooleanJsonSchema1
validate
validateAndBox

MapOfEnumStringBoxed

public sealed interface MapOfEnumStringBoxed
permits
MapOfEnumStringBoxedMap

sealed interface that stores validated payloads using boxed classes

MapOfEnumStringBoxedMap

public record MapOfEnumStringBoxedMap
implements MapOfEnumStringBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
MapOfEnumStringBoxedMap(MapOfEnumStringMap data)
Creates an instance, private visibility

Method Summary

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

MapOfEnumString

public static class MapOfEnumString
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.MapTest;

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

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

// Map validation
MapTest.MapOfEnumStringMap validatedPayload =
    MapTest.MapOfEnumString.validate(
    new MapTest.MapOfEnumStringMapBuilder()
        .additionalProperty("someAdditionalProperty", "UPPER")

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

MapOfEnumStringMapBuilder

public class MapOfEnumStringMapBuilder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

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

MapOfEnumStringMap

public static class MapOfEnumStringMap
extends FrozenMap<String, String>

A class to store validated Map payloads

Method Summary

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

AdditionalProperties2Boxed

public sealed interface AdditionalProperties2Boxed
permits
AdditionalProperties2BoxedString

sealed interface that stores validated payloads using boxed classes

AdditionalProperties2BoxedString

public record AdditionalProperties2BoxedString
implements AdditionalProperties2Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

AdditionalProperties2

public static class AdditionalProperties2
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.MapTest;

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

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

// String validation
String validatedPayload = MapTest.AdditionalProperties2.validate(
    "UPPER",
    configuration
);

Field Summary

Modifier and Type Field and Description
Set<Class<?>> type = Set.of(
    String.class
)
Set enumValues = SetMaker.makeSet(
    "UPPER",
    "lower"
)

Method Summary

Modifier and Type Method and Description
String validate(String arg, SchemaConfiguration configuration)
String validate(StringAdditionalPropertiesEnums arg, SchemaConfiguration configuration)
AdditionalProperties2BoxedString validateAndBox(String arg, SchemaConfiguration configuration)
AdditionalProperties2Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

StringAdditionalPropertiesEnums

public enum StringAdditionalPropertiesEnums
extends Enum<StringAdditionalPropertiesEnums>

A class that stores String enum values

Enum Constant Summary

Enum Constant Description
UPPER value = "UPPER"
LOWER value = "lower"

MapMapOfStringBoxed

public sealed interface MapMapOfStringBoxed
permits
MapMapOfStringBoxedMap

sealed interface that stores validated payloads using boxed classes

MapMapOfStringBoxedMap

public record MapMapOfStringBoxedMap
implements MapMapOfStringBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
MapMapOfStringBoxedMap(MapMapOfStringMap data)
Creates an instance, private visibility

Method Summary

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

MapMapOfString

public static class MapMapOfString
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.MapTest;

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

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

// Map validation
MapTest.MapMapOfStringMap validatedPayload =
    MapTest.MapMapOfString.validate(
    new MapTest.MapMapOfStringMapBuilder()
        .additionalProperty(
            "someAdditionalProperty",
            MapUtils.makeMap(
                new AbstractMap.SimpleEntry<String, String>(
                    "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
MapMapOfStringMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
MapMapOfStringBoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
MapMapOfStringBoxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

MapMapOfStringMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

MapMapOfStringMap

public static class MapMapOfStringMap
extends FrozenMap<String, AdditionalPropertiesMap>

A class to store validated Map payloads

Method Summary

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

AdditionalPropertiesBoxed

public sealed interface AdditionalPropertiesBoxed
permits
AdditionalPropertiesBoxedMap

sealed interface that stores validated payloads using boxed classes

AdditionalPropertiesBoxedMap

public record AdditionalPropertiesBoxedMap
implements AdditionalPropertiesBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedMap(AdditionalPropertiesMap data)
Creates an instance, private visibility

Method Summary

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

AdditionalProperties

public static class AdditionalProperties
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.MapTest;

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

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

// Map validation
MapTest.AdditionalPropertiesMap validatedPayload =
    MapTest.AdditionalProperties.validate(
    new MapTest.AdditionalPropertiesMapBuilder1()
        .additionalProperty("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
AdditionalPropertiesMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
AdditionalPropertiesBoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
AdditionalPropertiesBoxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

AdditionalPropertiesMapBuilder1

public class AdditionalPropertiesMapBuilder1
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

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

AdditionalProperties1Boxed

public sealed interface AdditionalProperties1Boxed
permits
AdditionalProperties1BoxedString

sealed interface that stores validated payloads using boxed classes

AdditionalProperties1BoxedString

public record AdditionalProperties1BoxedString
implements AdditionalProperties1Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

AdditionalProperties1

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