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

Latest commit

 

History

History
190 lines (158 loc) · 11.3 KB

File metadata and controls

190 lines (158 loc) · 11.3 KB

ReqPropsFromTrueAddProps

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

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 ReqPropsFromTrueAddProps.ReqPropsFromTrueAddProps1
schema class
static class ReqPropsFromTrueAddProps.ReqPropsFromTrueAddPropsMapBuilder
builder for Map payloads
static class ReqPropsFromTrueAddProps.ReqPropsFromTrueAddPropsMap
output class for Map payloads
static class ReqPropsFromTrueAddProps.AdditionalProperties
schema class

ReqPropsFromTrueAddProps1

public static class ReqPropsFromTrueAddProps1
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
ReqPropsFromTrueAddProps.ReqPropsFromTrueAddPropsMap validatedPayload =
    ReqPropsFromTrueAddProps.ReqPropsFromTrueAddProps1.validate(
    new ReqPropsFromTrueAddProps.ReqPropsFromTrueAddPropsMapBuilder()
    .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
ReqPropsFromTrueAddPropsMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

ReqPropsFromTrueAddPropsMap00Builder

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

A class that builds the Map input type

Constructor Summary

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

ReqPropsFromTrueAddPropsMap01Builder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

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

ReqPropsFromTrueAddPropsMap10Builder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

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

ReqPropsFromTrueAddPropsMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

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

ReqPropsFromTrueAddPropsMap

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

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static ReqPropsFromTrueAddPropsMap 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

AdditionalProperties

public static class AdditionalProperties
extends AnyTypeJsonSchema

A schema class that validates payloads

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

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