StringBooleanMap.md

StringBooleanMap

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

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	StringBooleanMap.StringBooleanMap1Boxed sealed interface for validated payloads
record	StringBooleanMap.StringBooleanMap1BoxedMap boxed class to store validated Map payloads
static class	StringBooleanMap.StringBooleanMap1 schema class
static class	StringBooleanMap.StringBooleanMapMapBuilder builder for Map payloads
static class	StringBooleanMap.StringBooleanMapMap output class for Map payloads
sealed interface	StringBooleanMap.AdditionalPropertiesBoxed sealed interface for validated payloads
record	StringBooleanMap.AdditionalPropertiesBoxedBoolean boxed class to store validated boolean payloads
static class	StringBooleanMap.AdditionalProperties schema class

StringBooleanMap1Boxed

public sealed interface StringBooleanMap1Boxed
permits
StringBooleanMap1BoxedMap

sealed interface that stores validated payloads using boxed classes

StringBooleanMap1BoxedMap

public record StringBooleanMap1BoxedMap
implements StringBooleanMap1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
StringBooleanMap1BoxedMap(StringBooleanMapMap data) Creates an instance, private visibility

Method Summary

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

StringBooleanMap1

public static class StringBooleanMap1
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.StringBooleanMap;

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

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

// Map validation
StringBooleanMap.StringBooleanMapMap validatedPayload =
    StringBooleanMap.StringBooleanMap1.validate(
    new StringBooleanMap.StringBooleanMapMapBuilder()
        .additionalProperty("someAdditionalProperty", true)

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

StringBooleanMapMapBuilder

public class StringBooleanMapMapBuilder
builder for Map<String, Boolean>

A class that builds the Map input type

Constructor Summary

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

StringBooleanMapMap

public static class StringBooleanMapMap
extends FrozenMap<String, Boolean>

A class to store validated Map payloads

Method Summary

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

AdditionalPropertiesBoxed

public sealed interface AdditionalPropertiesBoxed
permits
AdditionalPropertiesBoxedBoolean

sealed interface that stores validated payloads using boxed classes

AdditionalPropertiesBoxedBoolean

public record AdditionalPropertiesBoxedBoolean
implements AdditionalPropertiesBoxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

AdditionalProperties

public static class AdditionalProperties
extends BooleanJsonSchema.BooleanJsonSchema1

A schema class that validates payloads

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

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