ReqPropsFromExplicitAddProps.md

ReqPropsFromExplicitAddProps

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

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	ReqPropsFromExplicitAddProps.ReqPropsFromExplicitAddProps1Boxed sealed interface for validated payloads
record	ReqPropsFromExplicitAddProps.ReqPropsFromExplicitAddProps1BoxedMap boxed class to store validated Map payloads
static class	ReqPropsFromExplicitAddProps.ReqPropsFromExplicitAddProps1 schema class
static class	ReqPropsFromExplicitAddProps.ReqPropsFromExplicitAddPropsMapBuilder builder for Map payloads
static class	ReqPropsFromExplicitAddProps.ReqPropsFromExplicitAddPropsMap output class for Map payloads
sealed interface	ReqPropsFromExplicitAddProps.AdditionalPropertiesBoxed sealed interface for validated payloads
record	ReqPropsFromExplicitAddProps.AdditionalPropertiesBoxedString boxed class to store validated String payloads
static class	ReqPropsFromExplicitAddProps.AdditionalProperties schema class

ReqPropsFromExplicitAddProps1Boxed

public sealed interface ReqPropsFromExplicitAddProps1Boxed
permits
ReqPropsFromExplicitAddProps1BoxedMap

sealed interface that stores validated payloads using boxed classes

ReqPropsFromExplicitAddProps1BoxedMap

public record ReqPropsFromExplicitAddProps1BoxedMap
implements ReqPropsFromExplicitAddProps1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ReqPropsFromExplicitAddProps1BoxedMap(ReqPropsFromExplicitAddPropsMap data) Creates an instance, private visibility

Method Summary

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

ReqPropsFromExplicitAddProps1

public static class ReqPropsFromExplicitAddProps1
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.ReqPropsFromExplicitAddProps;

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

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

// Map validation
ReqPropsFromExplicitAddProps.ReqPropsFromExplicitAddPropsMap validatedPayload =
    ReqPropsFromExplicitAddProps.ReqPropsFromExplicitAddProps1.validate(
    new ReqPropsFromExplicitAddProps.ReqPropsFromExplicitAddPropsMapBuilder()
        .invalidHyphenMinusName("a")

    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(Map.class)
Set	required = Set.of(     "invalid-name",     "validName" )
Class<? extends JsonSchema>	additionalProperties = AdditionalProperties.class

Method Summary

Modifier and Type	Method and Description
ReqPropsFromExplicitAddPropsMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
ReqPropsFromExplicitAddProps1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
ReqPropsFromExplicitAddProps1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ReqPropsFromExplicitAddPropsMap00Builder

public class ReqPropsFromExplicitAddPropsMap00Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
ReqPropsFromExplicitAddPropsMap00Builder(Map<String, String> instance) Creates a builder that contains the passed instance

Method Summary

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

ReqPropsFromExplicitAddPropsMap01Builder

public class ReqPropsFromExplicitAddPropsMap01Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
ReqPropsFromExplicitAddPropsMap01Builder(Map<String, String> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
ReqPropsFromExplicitAddPropsMap00Builder	validName(String value)

ReqPropsFromExplicitAddPropsMap10Builder

public class ReqPropsFromExplicitAddPropsMap10Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
ReqPropsFromExplicitAddPropsMap10Builder(Map<String, String> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
ReqPropsFromExplicitAddPropsMap00Builder	invalidHyphenMinusName(String value)

ReqPropsFromExplicitAddPropsMapBuilder

public class ReqPropsFromExplicitAddPropsMapBuilder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
ReqPropsFromExplicitAddPropsMap01Builder	invalidHyphenMinusName(String value)
ReqPropsFromExplicitAddPropsMap10Builder	validName(String value)

ReqPropsFromExplicitAddPropsMap

public static class ReqPropsFromExplicitAddPropsMap
extends FrozenMap<String, String>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static ReqPropsFromExplicitAddPropsMap	of(Map<String, String> arg, SchemaConfiguration configuration)
String	validName()
String	get(String key) This schema has invalid Java names so this method must be used when you access instance["invalid-name"],
String	getAdditionalProperty(String name) provides type safety for additional properties

AdditionalPropertiesBoxed

public sealed interface AdditionalPropertiesBoxed
permits
AdditionalPropertiesBoxedString

sealed interface that stores validated payloads using boxed classes

AdditionalPropertiesBoxedString

public record AdditionalPropertiesBoxedString
implements AdditionalPropertiesBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

AdditionalProperties

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