Apple.md

Apple

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

A class that contains necessary nested schema classes, and classes to store validated list and map payloads

Nested Class Summary

Modifier and Type	Class and Description
static class	Apple.Apple1 schema class
static class	Apple.AppleMap output class for Map payloads
static class	Apple.Origin schema class
static class	Apple.Cultivar schema class

Apple1

public static class Apple1
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.MapMaker;
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());

// null validation
Void validatedPayload = Apple.Apple1.validate(
    (Void) null,
    configuration
);

// Map validation
Apple.AppleMap validatedPayload =
    Apple.Apple1.validate(
    MapMaker.makeMap(
        new AbstractMap.SimpleEntry<>(
            "cultivar",
            "IaQn�EaqioxT	oASzjxaSH"
        ),
        new AbstractMap.SimpleEntry<>(
            "origin",
            "IaQn�EaqioxT	oASzjxaSH"
        )
    ),
    configuration
);

Field Summary

Modifier and Type

Field and Description

static LinkedHashMap<String, KeywordValidator>

keywordToValidator new LinkedHashMap<>(Map.ofEntries(     new KeywordEntry("type", new TypeValidator(Set.of(         Void.class,         FrozenMap.class     ))),     new KeywordEntry("properties", new PropertiesValidator(Map.ofEntries(         new PropertyEntry("cultivar", Cultivar.class)),         new PropertyEntry("origin", Origin.class))     ))),     new KeywordEntry("required", new RequiredValidator(Set.of(         "cultivar"     ))) ));

Method Summary

Modifier and Type	Method and Description
static Void	validate(Void arg, SchemaConfiguration configuration)
static AppleMap	validate(Map<String, Object> arg, SchemaConfiguration configuration)

AppleMap

public static class AppleMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static AppleMap	of(Map<String, Object> arg, SchemaConfiguration configuration)
String	cultivar()
String	origin() [optional]
Object	getAdditionalProperty(String name) provides type safety for additional properties

Input Map Keys

type: Map<String, Object>

Key	Type	Description	Notes
cultivar	String
origin	String		[optional]
anyStringName	Object	any string name can be used but the value must be the correct type	[optional]

Origin

public static class Origin
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.MapMaker;
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());

// String validation
String validatedPayload = Apple.Origin.validate(
    "IaQn�EaqioxT	oASzjxaSH",
    configuration
);

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries(     new KeywordEntry("type", new TypeValidator(Set.of(         String.class     ))),     new KeywordEntry("pattern", new PatternValidator(         "^[A-Z\s]*$",         Pattern.CASE_INSENSITIVE     ))) ));

Method Summary

Modifier and Type	Method and Description
static String	validate(String arg, SchemaConfiguration configuration)

Cultivar

public static class Cultivar
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.MapMaker;
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());

// String validation
String validatedPayload = Apple.Cultivar.validate(
    "IaQn�EaqioxT	oASzjxaSH",
    configuration
);

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries(     new KeywordEntry("type", new TypeValidator(Set.of(         String.class     ))),     new KeywordEntry("pattern", new PatternValidator(         "^[a-zA-Z\s]*$"     ))) ));

Method Summary

Modifier and Type	Method and Description
static String	validate(String arg, SchemaConfiguration configuration)

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