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

Latest commit

 

History

History
146 lines (114 loc) · 5.65 KB

File metadata and controls

146 lines (114 loc) · 5.65 KB

BananaReq

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

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 BananaReq.BananaReq1
schema class
static class BananaReq.BananaReqMapBuilder
builder for Map payloads
static class BananaReq.BananaReqMap
output class for Map payloads
static class BananaReq.Sweet
schema class
static class BananaReq.LengthCm
schema class
static class BananaReq.AdditionalProperties
schema class

BananaReq1

public static class BananaReq1
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
BananaReq.BananaReqMap validatedPayload =
    BananaReq.BananaReq1.validate(
    new BananaReq.BananaReqMapBuilder()
        .lengthCm(1)

        .sweet(true)

    .build(),
    configuration
);

Field Summary

Modifier and Type Field and Description
Set<Class<?>> type = Set.of(Map.class)
Map<String, Class<? extends JsonSchema>> properties = Map.ofEntries(
    new PropertyEntry("lengthCm", LengthCm.class)),
    new PropertyEntry("sweet", Sweet.class))
)
Set required = Set.of(
    "lengthCm"
)
Class<? extends JsonSchema> additionalProperties = AdditionalProperties.class

Method Summary

Modifier and Type Method and Description
BananaReqMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

BananaReqMap0Builder

public class BananaReqMap0Builder
builder for Map<String, Object>

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type Method and Description
Map<String, Object> build()
Returns map input that should be used with Schema.validate
BananaReqMap0Builder sweet(boolean value)

BananaReqMapBuilder

public class BananaReqMapBuilder
builder for Map<String, Object>

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type Method and Description
BananaReqMap0Builder lengthCm(int value)
BananaReqMap0Builder lengthCm(float value)
BananaReqMap0Builder lengthCm(long value)
BananaReqMap0Builder lengthCm(double value)

BananaReqMap

public static class BananaReqMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static BananaReqMap of(Map<String, Object> arg, SchemaConfiguration configuration)
Number lengthCm()
boolean sweet()
[optional]

Sweet

public static class Sweet
extends BooleanJsonSchema

A schema class that validates payloads

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

LengthCm

public static class LengthCm
extends NumberJsonSchema

A schema class that validates payloads

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

AdditionalProperties

public static class AdditionalProperties
extends NotAnyTypeJsonSchema

A schema class that validates payloads

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

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