AdditionalPropertiesWithArrayOfEnums.md

AdditionalPropertiesWithArrayOfEnums

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

A class that contains necessary nested

• schema classes (which validate payloads), extends JsonSchema
• classes to store validated list payloads, extends FrozenList
• classes to build inputs for list payloads
• 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	AdditionalPropertiesWithArrayOfEnums.AdditionalPropertiesWithArrayOfEnums1 schema class
static class	AdditionalPropertiesWithArrayOfEnums.AdditionalPropertiesWithArrayOfEnumsMapBuilder builder for Map payloads
static class	AdditionalPropertiesWithArrayOfEnums.AdditionalPropertiesWithArrayOfEnumsMap output class for Map payloads
static class	AdditionalPropertiesWithArrayOfEnums.AdditionalProperties schema class
static class	AdditionalPropertiesWithArrayOfEnums.AdditionalPropertiesListBuilder builder for List payloads
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.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
AdditionalPropertiesWithArrayOfEnums.AdditionalPropertiesWithArrayOfEnumsMap validatedPayload =
    AdditionalPropertiesWithArrayOfEnums.AdditionalPropertiesWithArrayOfEnums1.validate(
    new AdditionalPropertiesWithArrayOfEnums.AdditionalPropertiesWithArrayOfEnumsMapBuilder()
        .additionalProperty(
            "someAdditionalProperty",
            Arrays.asList(
                "_abc"
            )
        )
    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(Map.class)
Class<? extends JsonSchema>	additionalProperties = AdditionalProperties.class

Method Summary

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

AdditionalPropertiesWithArrayOfEnumsMapBuilder

public class AdditionalPropertiesWithArrayOfEnumsMapBuilder
builder for Map<String, List<String>>

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Map<String, List>	build() Returns map input that should be used with Schema.validate
AdditionalPropertiesWithArrayOfEnumsMapBuilder	additionalProperty(String key, List value)

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

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.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());

// List validation
AdditionalPropertiesWithArrayOfEnums.AdditionalPropertiesList validatedPayload =
    AdditionalPropertiesWithArrayOfEnums.AdditionalProperties.validate(
    new AdditionalPropertiesWithArrayOfEnums.AdditionalPropertiesListBuilder()
        .add("_abc")

    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(List.class)
Class<? extends JsonSchema>	items = EnumClass.EnumClass1.class

Method Summary

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

AdditionalPropertiesListBuilder

public class AdditionalPropertiesListBuilder
builder for List<String>

A class that builds the List input type

Constructor Summary

Constructor and Description
AdditionalPropertiesListBuilder() Creates an empty list
AdditionalPropertiesListBuilder(List items) Stores the items in a list

Method Summary

Modifier and Type	Method and Description
AdditionalPropertiesListBuilder	add(String item)
AdditionalPropertiesListBuilder	add(EnumClass.StringEnumClassEnums item)
List	build() Returns list input that should be used with Schema.validate

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)

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