AppleReq.md

AppleReq

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

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	AppleReq.AppleReq1 schema class
static class	AppleReq.AppleReqMapBuilder builder for Map payloads
static class	AppleReq.AppleReqMap output class for Map payloads
static class	AppleReq.Mealy schema class
static class	AppleReq.Cultivar schema class
static class	AppleReq.AdditionalProperties schema class

AppleReq1

public static class AppleReq1
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
AppleReq.AppleReqMap validatedPayload =
    AppleReq.AppleReq1.validate(
    new AppleReq.AppleReqMapBuilder()
        .cultivar("a")

        .mealy(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("cultivar", Cultivar.class)),     new PropertyEntry("mealy", Mealy.class)) )
Set	required = Set.of(     "cultivar" )
Class<? extends JsonSchema>	additionalProperties = AdditionalProperties.class

Method Summary

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

AppleReqMap0Builder

public class AppleReqMap0Builder
builder for Map<String, Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
AppleReqMap0Builder(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
AppleReqMap0Builder	mealy(boolean value)

AppleReqMapBuilder

public class AppleReqMapBuilder
builder for Map<String, Object>

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
AppleReqMap0Builder	cultivar(String value)

AppleReqMap

public static class AppleReqMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static AppleReqMap	of(Map<String, Object> arg, SchemaConfiguration configuration)
String	cultivar()
boolean	mealy() [optional]

Mealy

public static class Mealy
extends BooleanJsonSchema

A schema class that validates payloads

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

Cultivar

public static class Cultivar
extends StringJsonSchema

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.StringJsonSchema
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]