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

Latest commit

 

History

History
210 lines (174 loc) · 12.7 KB

ReqPropsFromUnsetAddProps.md

File metadata and controls

210 lines (174 loc) · 12.7 KB

ReqPropsFromUnsetAddProps

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

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 ReqPropsFromUnsetAddProps.ReqPropsFromUnsetAddProps1Boxed
sealed interface for validated payloads
record ReqPropsFromUnsetAddProps.ReqPropsFromUnsetAddProps1BoxedMap
boxed class to store validated Map payloads
static class ReqPropsFromUnsetAddProps.ReqPropsFromUnsetAddProps1
schema class
static class ReqPropsFromUnsetAddProps.ReqPropsFromUnsetAddPropsMapBuilder
builder for Map payloads
static class ReqPropsFromUnsetAddProps.ReqPropsFromUnsetAddPropsMap
output class for Map payloads

ReqPropsFromUnsetAddProps1Boxed

public sealed interface ReqPropsFromUnsetAddProps1Boxed
permits
ReqPropsFromUnsetAddProps1BoxedMap

sealed interface that stores validated payloads using boxed classes

ReqPropsFromUnsetAddProps1BoxedMap

public record ReqPropsFromUnsetAddProps1BoxedMap
implements ReqPropsFromUnsetAddProps1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ReqPropsFromUnsetAddProps1BoxedMap(ReqPropsFromUnsetAddPropsMap data)
Creates an instance, private visibility

Method Summary

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

ReqPropsFromUnsetAddProps1

public static class ReqPropsFromUnsetAddProps1
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.ReqPropsFromUnsetAddProps;

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

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

// Map validation
ReqPropsFromUnsetAddProps.ReqPropsFromUnsetAddPropsMap validatedPayload =
    ReqPropsFromUnsetAddProps.ReqPropsFromUnsetAddProps1.validate(
    new ReqPropsFromUnsetAddProps.ReqPropsFromUnsetAddPropsMapBuilder()
    .build(),
    configuration
);

Field Summary

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

Method Summary

Modifier and Type Method and Description
ReqPropsFromUnsetAddPropsMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
ReqPropsFromUnsetAddProps1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
ReqPropsFromUnsetAddProps1Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

ReqPropsFromUnsetAddPropsMap00Builder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
ReqPropsFromUnsetAddPropsMap00Builder(Map<String, @Nullable Object> instance)
Creates a builder that contains the passed instance

Method Summary

Modifier and Type Method and Description
Map<String, @Nullable Object> build()
Returns map input that should be used with Schema.validate
ReqPropsFromUnsetAddPropsMap00Builder additionalProperty(String key, Void value)
ReqPropsFromUnsetAddPropsMap00Builder additionalProperty(String key, boolean value)
ReqPropsFromUnsetAddPropsMap00Builder additionalProperty(String key, String value)
ReqPropsFromUnsetAddPropsMap00Builder additionalProperty(String key, int value)
ReqPropsFromUnsetAddPropsMap00Builder additionalProperty(String key, float value)
ReqPropsFromUnsetAddPropsMap00Builder additionalProperty(String key, long value)
ReqPropsFromUnsetAddPropsMap00Builder additionalProperty(String key, double value)
ReqPropsFromUnsetAddPropsMap00Builder additionalProperty(String key, List<?> value)
ReqPropsFromUnsetAddPropsMap00Builder additionalProperty(String key, Map<String, ?> value)

ReqPropsFromUnsetAddPropsMap01Builder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
ReqPropsFromUnsetAddPropsMap01Builder(Map<String, @Nullable Object> instance)
Creates a builder that contains the passed instance

Method Summary

Modifier and Type Method and Description
ReqPropsFromUnsetAddPropsMap00Builder validName(Void value)
ReqPropsFromUnsetAddPropsMap00Builder validName(boolean value)
ReqPropsFromUnsetAddPropsMap00Builder validName(String value)
ReqPropsFromUnsetAddPropsMap00Builder validName(int value)
ReqPropsFromUnsetAddPropsMap00Builder validName(float value)
ReqPropsFromUnsetAddPropsMap00Builder validName(long value)
ReqPropsFromUnsetAddPropsMap00Builder validName(double value)
ReqPropsFromUnsetAddPropsMap00Builder validName(List<?> value)
ReqPropsFromUnsetAddPropsMap00Builder validName(Map<String, ?> value)

ReqPropsFromUnsetAddPropsMap10Builder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
ReqPropsFromUnsetAddPropsMap10Builder(Map<String, @Nullable Object> instance)
Creates a builder that contains the passed instance

Method Summary

Modifier and Type Method and Description
ReqPropsFromUnsetAddPropsMap00Builder invalidHyphenMinusName(Void value)
ReqPropsFromUnsetAddPropsMap00Builder invalidHyphenMinusName(boolean value)
ReqPropsFromUnsetAddPropsMap00Builder invalidHyphenMinusName(String value)
ReqPropsFromUnsetAddPropsMap00Builder invalidHyphenMinusName(int value)
ReqPropsFromUnsetAddPropsMap00Builder invalidHyphenMinusName(float value)
ReqPropsFromUnsetAddPropsMap00Builder invalidHyphenMinusName(long value)
ReqPropsFromUnsetAddPropsMap00Builder invalidHyphenMinusName(double value)
ReqPropsFromUnsetAddPropsMap00Builder invalidHyphenMinusName(List<?> value)
ReqPropsFromUnsetAddPropsMap00Builder invalidHyphenMinusName(Map<String, ?> value)

ReqPropsFromUnsetAddPropsMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type Method and Description
ReqPropsFromUnsetAddPropsMap01Builder invalidHyphenMinusName(Void value)
ReqPropsFromUnsetAddPropsMap01Builder invalidHyphenMinusName(boolean value)
ReqPropsFromUnsetAddPropsMap01Builder invalidHyphenMinusName(String value)
ReqPropsFromUnsetAddPropsMap01Builder invalidHyphenMinusName(int value)
ReqPropsFromUnsetAddPropsMap01Builder invalidHyphenMinusName(float value)
ReqPropsFromUnsetAddPropsMap01Builder invalidHyphenMinusName(long value)
ReqPropsFromUnsetAddPropsMap01Builder invalidHyphenMinusName(double value)
ReqPropsFromUnsetAddPropsMap01Builder invalidHyphenMinusName(List<?> value)
ReqPropsFromUnsetAddPropsMap01Builder invalidHyphenMinusName(Map<String, ?> value)
ReqPropsFromUnsetAddPropsMap10Builder validName(Void value)
ReqPropsFromUnsetAddPropsMap10Builder validName(boolean value)
ReqPropsFromUnsetAddPropsMap10Builder validName(String value)
ReqPropsFromUnsetAddPropsMap10Builder validName(int value)
ReqPropsFromUnsetAddPropsMap10Builder validName(float value)
ReqPropsFromUnsetAddPropsMap10Builder validName(long value)
ReqPropsFromUnsetAddPropsMap10Builder validName(double value)
ReqPropsFromUnsetAddPropsMap10Builder validName(List<?> value)
ReqPropsFromUnsetAddPropsMap10Builder validName(Map<String, ?> value)

ReqPropsFromUnsetAddPropsMap

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

A class to store validated Map payloads

Method Summary

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

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