ComposedArray.md

ComposedArray

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

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

Nested Class Summary

Modifier and Type	Class and Description
static class	ComposedArray.ComposedArray1 schema class
static class	ComposedArray.ComposedArrayListBuilder builder for List payloads
static class	ComposedArray.ComposedArrayList output class for List payloads
static class	ComposedArray.Items schema class

ComposedArray1

public static class ComposedArray1
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
ComposedArray.ComposedArrayList validatedPayload =
    ComposedArray.ComposedArray1.validate(
    new ComposedArray.ComposedArrayListBuilder()
    .build(),
    configuration
);

Field Summary

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

Method Summary

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

ComposedArrayListBuilder

public class ComposedArrayListBuilder
builder for List<@Nullable Object>

A class that builds the List input type

Constructor Summary

Constructor and Description
ComposedArrayListBuilder() Creates an empty list
ComposedArrayListBuilder(List<@Nullable Object> items) Stores the items in a list

Method Summary

Modifier and Type	Method and Description
ComposedArrayListBuilder	add(Void item)
ComposedArrayListBuilder	add(boolean item)
ComposedArrayListBuilder	add(String item)
ComposedArrayListBuilder	add(int item)
ComposedArrayListBuilder	add(float item)
ComposedArrayListBuilder	add(long item)
ComposedArrayListBuilder	add(double item)
ComposedArrayListBuilder	add(List<?> item)
ComposedArrayListBuilder	add(Map<String, ?> item)
List<@Nullable Object>	build() Returns list input that should be used with Schema.validate

ComposedArrayList

public class ComposedArrayList
extends FrozenList<@Nullable Object>

A class to store validated List payloads

Method Summary

Modifier and Type	Method and Description
static ComposedArrayList	of(List<? extends @Nullable Object> arg, SchemaConfiguration configuration)

Items

public static class Items
extends AnyTypeJsonSchema

A schema class that validates payloads

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

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