JSONPatchRequest.md

JSONPatchRequest

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

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	JSONPatchRequest.JSONPatchRequest1 schema class
static class	JSONPatchRequest.JSONPatchRequestListBuilder builder for List payloads
static class	JSONPatchRequest.JSONPatchRequestList output class for List payloads
static class	JSONPatchRequest.Items schema class

JSONPatchRequest1

public static class JSONPatchRequest1
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
JSONPatchRequest.JSONPatchRequestList validatedPayload =
    JSONPatchRequest.JSONPatchRequest1.validate(
    new JSONPatchRequest.JSONPatchRequestListBuilder()
    .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
JSONPatchRequestList	validate(List<?> arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

JSONPatchRequestListBuilder

public class JSONPatchRequestListBuilder
builder for List<@Nullable Object>

A class that builds the List input type

Constructor Summary

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

Method Summary

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

JSONPatchRequestList

public class JSONPatchRequestList
extends FrozenList<@Nullable Object>

A class to store validated List payloads

Method Summary

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

Items

public static class Items
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type	Field and Description
List<Class<? extends JsonSchema>>	oneOf = List.of(     JSONPatchRequestAddReplaceTest.JSONPatchRequestAddReplaceTest1.class,     JSONPatchRequestRemove.JSONPatchRequestRemove1.class,     JSONPatchRequestMoveCopy.JSONPatchRequestMoveCopy1.class ))

Method Summary

Modifier and Type	Method and Description
String	validate(String arg, SchemaConfiguration configuration)
Void	validate(Void arg, SchemaConfiguration configuration)
int	validate(int arg, SchemaConfiguration configuration)
long	validate(long arg, SchemaConfiguration configuration)
float	validate(float arg, SchemaConfiguration configuration)
double	validate(double arg, SchemaConfiguration configuration)
boolean	validate(boolean arg, SchemaConfiguration configuration)
FrozenMap<String, @Nullable Object>	validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object>	validate(List<?> arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)
[Back to top] [Back to Component Schemas] [Back to README]