AdditionalPropertiesWithArrayOfEnums.md

AdditionalPropertiesWithArrayOfEnums

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

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	AdditionalPropertiesWithArrayOfEnums.AdditionalPropertiesWithArrayOfEnums1 schema class
static class	AdditionalPropertiesWithArrayOfEnums.AdditionalPropertiesWithArrayOfEnumsMap output class for Map payloads
static class	AdditionalPropertiesWithArrayOfEnums.AdditionalProperties schema class
static class	AdditionalPropertiesWithArrayOfEnums.AdditionalPropertiesList output class for List payloads

AdditionalPropertiesWithArrayOfEnums1

public static class AdditionalPropertiesWithArrayOfEnums1
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());

// Map validation
AdditionalPropertiesWithArrayOfEnums.AdditionalPropertiesWithArrayOfEnumsMap validatedPayload =
    AdditionalPropertiesWithArrayOfEnums.AdditionalPropertiesWithArrayOfEnums1.validate(
    MapMaker.makeMap(
    ),
    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(FrozenMap.class))),     new KeywordEntry("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties.class)) ));

Method Summary

Modifier and Type	Method and Description
static AdditionalPropertiesWithArrayOfEnumsMap	validate(Map<String, List> arg, SchemaConfiguration configuration)

AdditionalPropertiesWithArrayOfEnumsMap

public static class AdditionalPropertiesWithArrayOfEnumsMap
extends FrozenMap<String, AdditionalPropertiesList>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static AdditionalPropertiesWithArrayOfEnumsMap	of(Map<String, List> arg, SchemaConfiguration configuration)
AdditionalPropertiesList	getAdditionalProperty(String name) provides type safety for additional properties

Input Map Keys

type: Map<String, Object>

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

AdditionalProperties

public static class AdditionalProperties
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());

// List validation
AdditionalPropertiesWithArrayOfEnums.AdditionalPropertiesList validatedPayload =
    AdditionalPropertiesWithArrayOfEnums.AdditionalProperties.validate(
    Arrays.asList(
        "_abc"
    ),
    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(FrozenList.class))),     new KeywordEntry("items", new ItemsValidator(EnumClass.EnumClass1.class) ));

Method Summary

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

AdditionalPropertiesList

public class AdditionalPropertiesList
extends FrozenList<String>

A class to store validated List payloads

Method Summary

Modifier and Type	Method and Description
static AdditionalPropertiesList	of(List arg, SchemaConfiguration configuration)

Input List Items

type: List<String>

List Item Type	Description	Notes
String

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