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

Latest commit

 

History

History
344 lines (279 loc) · 18.5 KB

ReqPropsFromTrueAddProps.md

File metadata and controls

344 lines (279 loc) · 18.5 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
  • 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 ReqPropsFromTrueAddProps.ReqPropsFromTrueAddProps1Boxed
sealed interface for validated payloads
record ReqPropsFromTrueAddProps.ReqPropsFromTrueAddProps1BoxedMap
boxed class to store validated Map payloads
static class ReqPropsFromTrueAddProps.ReqPropsFromTrueAddProps1
schema class
static class ReqPropsFromTrueAddProps.ReqPropsFromTrueAddPropsMapBuilder
builder for Map payloads
static class ReqPropsFromTrueAddProps.ReqPropsFromTrueAddPropsMap
output class for Map payloads
sealed interface ReqPropsFromTrueAddProps.AdditionalPropertiesBoxed
sealed interface for validated payloads
record ReqPropsFromTrueAddProps.AdditionalPropertiesBoxedVoid
boxed class to store validated null payloads
record ReqPropsFromTrueAddProps.AdditionalPropertiesBoxedBoolean
boxed class to store validated boolean payloads
record ReqPropsFromTrueAddProps.AdditionalPropertiesBoxedNumber
boxed class to store validated Number payloads
record ReqPropsFromTrueAddProps.AdditionalPropertiesBoxedString
boxed class to store validated String payloads
record ReqPropsFromTrueAddProps.AdditionalPropertiesBoxedList
boxed class to store validated List payloads
record ReqPropsFromTrueAddProps.AdditionalPropertiesBoxedMap
boxed class to store validated Map payloads
static class ReqPropsFromTrueAddProps.AdditionalProperties
schema class

ReqPropsFromTrueAddProps1Boxed

public sealed interface ReqPropsFromTrueAddProps1Boxed
permits
ReqPropsFromTrueAddProps1BoxedMap

sealed interface that stores validated payloads using boxed classes

ReqPropsFromTrueAddProps1BoxedMap

public record ReqPropsFromTrueAddProps1BoxedMap
implements ReqPropsFromTrueAddProps1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ReqPropsFromTrueAddProps1BoxedMap(ReqPropsFromTrueAddPropsMap data)
Creates an instance, private visibility

Method Summary

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

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 org.openapijsonschematools.client.components.schemas.ReqPropsFromTrueAddProps;

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

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

// 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)
ReqPropsFromTrueAddProps1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
ReqPropsFromTrueAddProps1Boxed validateAndBox(@Nullable Object 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 invalidHyphenMinusName(Void value)
ReqPropsFromTrueAddPropsMap00Builder invalidHyphenMinusName(boolean value)
ReqPropsFromTrueAddPropsMap00Builder invalidHyphenMinusName(String value)
ReqPropsFromTrueAddPropsMap00Builder invalidHyphenMinusName(int value)
ReqPropsFromTrueAddPropsMap00Builder invalidHyphenMinusName(float value)
ReqPropsFromTrueAddPropsMap00Builder invalidHyphenMinusName(long value)
ReqPropsFromTrueAddPropsMap00Builder invalidHyphenMinusName(double value)
ReqPropsFromTrueAddPropsMap00Builder invalidHyphenMinusName(List<?> value)
ReqPropsFromTrueAddPropsMap00Builder invalidHyphenMinusName(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 invalidHyphenMinusName(Void value)
ReqPropsFromTrueAddPropsMap01Builder invalidHyphenMinusName(boolean value)
ReqPropsFromTrueAddPropsMap01Builder invalidHyphenMinusName(String value)
ReqPropsFromTrueAddPropsMap01Builder invalidHyphenMinusName(int value)
ReqPropsFromTrueAddPropsMap01Builder invalidHyphenMinusName(float value)
ReqPropsFromTrueAddPropsMap01Builder invalidHyphenMinusName(long value)
ReqPropsFromTrueAddPropsMap01Builder invalidHyphenMinusName(double value)
ReqPropsFromTrueAddPropsMap01Builder invalidHyphenMinusName(List<?> value)
ReqPropsFromTrueAddPropsMap01Builder invalidHyphenMinusName(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

AdditionalPropertiesBoxed

public sealed interface AdditionalPropertiesBoxed
permits
AdditionalPropertiesBoxedVoid, AdditionalPropertiesBoxedBoolean, AdditionalPropertiesBoxedNumber, AdditionalPropertiesBoxedString, AdditionalPropertiesBoxedList, AdditionalPropertiesBoxedMap

sealed interface that stores validated payloads using boxed classes

AdditionalPropertiesBoxedVoid

public record AdditionalPropertiesBoxedVoid
implements AdditionalPropertiesBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedVoid(Void data)
Creates an instance, private visibility

Method Summary

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

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

AdditionalPropertiesBoxedNumber

public record AdditionalPropertiesBoxedNumber
implements AdditionalPropertiesBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedNumber(Number data)
Creates an instance, private visibility

Method Summary

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

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

AdditionalPropertiesBoxedList

public record AdditionalPropertiesBoxedList
implements AdditionalPropertiesBoxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedList(FrozenList<@Nullable Object> data)
Creates an instance, private visibility

Method Summary

Modifier and Type Method and Description
FrozenList<@Nullable Object> data()
validated payload
@Nullable Object getData()
validated payload

AdditionalPropertiesBoxedMap

public record AdditionalPropertiesBoxedMap
implements AdditionalPropertiesBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedMap(FrozenMap<@Nullable Object> data)
Creates an instance, private visibility

Method Summary

Modifier and Type Method and Description
FrozenMap<@Nullable Object> data()
validated payload
@Nullable Object getData()
validated payload

AdditionalProperties

public static class AdditionalProperties
extends AnyTypeJsonSchema.AnyTypeJsonSchema1

A schema class that validates payloads

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

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