SelfReferencingArrayModel.md

SelfReferencingArrayModel

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

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	SelfReferencingArrayModel.SelfReferencingArrayModel1 schema class
static class	SelfReferencingArrayModel.SelfReferencingArrayModelListBuilder builder for List payloads
static class	SelfReferencingArrayModel.SelfReferencingArrayModelList output class for List payloads

SelfReferencingArrayModel1

public static class SelfReferencingArrayModel1
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
SelfReferencingArrayModel.SelfReferencingArrayModelList validatedPayload =
    SelfReferencingArrayModel.SelfReferencingArrayModel1.validate(
    new SelfReferencingArrayModel.SelfReferencingArrayModelListBuilder()
    .build(),
    configuration
);

Field Summary

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

Method Summary

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

SelfReferencingArrayModelListBuilder

public class SelfReferencingArrayModelListBuilder
builder for List<List<?>>

A class that builds the List input type

Constructor Summary

Constructor and Description
SelfReferencingArrayModelListBuilder() Creates an empty list
SelfReferencingArrayModelListBuilder(List<List<?>> items) Stores the items in a list

Method Summary

Modifier and Type	Method and Description
SelfReferencingArrayModelListBuilder	add(List<?> item)
List<List<?>>	build() Returns list input that should be used with Schema.validate

SelfReferencingArrayModelList

public class SelfReferencingArrayModelList
extends FrozenList<SelfReferencingArrayModelList>

A class to store validated List payloads

Method Summary

Modifier and Type	Method and Description
static SelfReferencingArrayModelList	of(List<List<?>> arg, SchemaConfiguration configuration)

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