JSONPatchRequestAddReplaceTest.md

JSONPatchRequestAddReplaceTest

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

A class that contains necessary nested

• schema classes (which validate payloads), extends JsonSchema
• classes to store validated map payloads, extends FrozenMap
• classes to build inputs for map payloads
• enum classes

Nested Class Summary

Modifier and Type	Class and Description
static class	JSONPatchRequestAddReplaceTest.JSONPatchRequestAddReplaceTest1 schema class
static class	JSONPatchRequestAddReplaceTest.JSONPatchRequestAddReplaceTestMapBuilder builder for Map payloads
static class	JSONPatchRequestAddReplaceTest.JSONPatchRequestAddReplaceTestMap output class for Map payloads
static class	JSONPatchRequestAddReplaceTest.Op schema class
enum	JSONPatchRequestAddReplaceTest.StringOpEnums String enum
static class	JSONPatchRequestAddReplaceTest.Value schema class
static class	JSONPatchRequestAddReplaceTest.Path schema class
static class	JSONPatchRequestAddReplaceTest.AdditionalProperties schema class

JSONPatchRequestAddReplaceTest1

public static class JSONPatchRequestAddReplaceTest1
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
JSONPatchRequestAddReplaceTest.JSONPatchRequestAddReplaceTestMap validatedPayload =
    JSONPatchRequestAddReplaceTest.JSONPatchRequestAddReplaceTest1.validate(
    new JSONPatchRequestAddReplaceTest.JSONPatchRequestAddReplaceTestMapBuilder()
        .op("add")

        .path("a")

    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(Map.class)
Map<String, Class<? extends JsonSchema>>	properties = Map.ofEntries(     new PropertyEntry("path", Path.class)),     new PropertyEntry("value", Value.class)),     new PropertyEntry("op", Op.class)) )
Set	required = Set.of(     "op",     "path",     "value" )
Class<? extends JsonSchema>	additionalProperties = AdditionalProperties.class

Method Summary

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

JSONPatchRequestAddReplaceTestMap000Builder

public class JSONPatchRequestAddReplaceTestMap000Builder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestAddReplaceTestMap000Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
Map<String, @Nullable Object>	build() Returns map input that should be used with Schema.validate

JSONPatchRequestAddReplaceTestMap001Builder

public class JSONPatchRequestAddReplaceTestMap001Builder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestAddReplaceTestMap001Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestAddReplaceTestMap000Builder	value(Void value)
JSONPatchRequestAddReplaceTestMap000Builder	value(boolean value)
JSONPatchRequestAddReplaceTestMap000Builder	value(String value)
JSONPatchRequestAddReplaceTestMap000Builder	value(int value)
JSONPatchRequestAddReplaceTestMap000Builder	value(float value)
JSONPatchRequestAddReplaceTestMap000Builder	value(long value)
JSONPatchRequestAddReplaceTestMap000Builder	value(double value)
JSONPatchRequestAddReplaceTestMap000Builder	value(List<?> value)
JSONPatchRequestAddReplaceTestMap000Builder	value(Map<String, ?> value)

JSONPatchRequestAddReplaceTestMap010Builder

public class JSONPatchRequestAddReplaceTestMap010Builder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestAddReplaceTestMap010Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestAddReplaceTestMap000Builder	path(String value)

JSONPatchRequestAddReplaceTestMap011Builder

public class JSONPatchRequestAddReplaceTestMap011Builder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestAddReplaceTestMap011Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestAddReplaceTestMap001Builder	path(String value)
JSONPatchRequestAddReplaceTestMap010Builder	value(Void value)
JSONPatchRequestAddReplaceTestMap010Builder	value(boolean value)
JSONPatchRequestAddReplaceTestMap010Builder	value(String value)
JSONPatchRequestAddReplaceTestMap010Builder	value(int value)
JSONPatchRequestAddReplaceTestMap010Builder	value(float value)
JSONPatchRequestAddReplaceTestMap010Builder	value(long value)
JSONPatchRequestAddReplaceTestMap010Builder	value(double value)
JSONPatchRequestAddReplaceTestMap010Builder	value(List<?> value)
JSONPatchRequestAddReplaceTestMap010Builder	value(Map<String, ?> value)

JSONPatchRequestAddReplaceTestMap100Builder

public class JSONPatchRequestAddReplaceTestMap100Builder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestAddReplaceTestMap100Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestAddReplaceTestMap000Builder	op(String value)
JSONPatchRequestAddReplaceTestMap000Builder	op(StringOpEnums value)

JSONPatchRequestAddReplaceTestMap101Builder

public class JSONPatchRequestAddReplaceTestMap101Builder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestAddReplaceTestMap101Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestAddReplaceTestMap001Builder	op(String value)
JSONPatchRequestAddReplaceTestMap001Builder	op(StringOpEnums value)
JSONPatchRequestAddReplaceTestMap100Builder	value(Void value)
JSONPatchRequestAddReplaceTestMap100Builder	value(boolean value)
JSONPatchRequestAddReplaceTestMap100Builder	value(String value)
JSONPatchRequestAddReplaceTestMap100Builder	value(int value)
JSONPatchRequestAddReplaceTestMap100Builder	value(float value)
JSONPatchRequestAddReplaceTestMap100Builder	value(long value)
JSONPatchRequestAddReplaceTestMap100Builder	value(double value)
JSONPatchRequestAddReplaceTestMap100Builder	value(List<?> value)
JSONPatchRequestAddReplaceTestMap100Builder	value(Map<String, ?> value)

JSONPatchRequestAddReplaceTestMap110Builder

public class JSONPatchRequestAddReplaceTestMap110Builder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestAddReplaceTestMap110Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestAddReplaceTestMap010Builder	op(String value)
JSONPatchRequestAddReplaceTestMap010Builder	op(StringOpEnums value)
JSONPatchRequestAddReplaceTestMap100Builder	path(String value)

JSONPatchRequestAddReplaceTestMapBuilder

public class JSONPatchRequestAddReplaceTestMapBuilder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestAddReplaceTestMap011Builder	op(String value)
JSONPatchRequestAddReplaceTestMap011Builder	op(StringOpEnums value)
JSONPatchRequestAddReplaceTestMap101Builder	path(String value)
JSONPatchRequestAddReplaceTestMap110Builder	value(Void value)
JSONPatchRequestAddReplaceTestMap110Builder	value(boolean value)
JSONPatchRequestAddReplaceTestMap110Builder	value(String value)
JSONPatchRequestAddReplaceTestMap110Builder	value(int value)
JSONPatchRequestAddReplaceTestMap110Builder	value(float value)
JSONPatchRequestAddReplaceTestMap110Builder	value(long value)
JSONPatchRequestAddReplaceTestMap110Builder	value(double value)
JSONPatchRequestAddReplaceTestMap110Builder	value(List<?> value)
JSONPatchRequestAddReplaceTestMap110Builder	value(Map<String, ?> value)

JSONPatchRequestAddReplaceTestMap

public static class JSONPatchRequestAddReplaceTestMap
extends FrozenMap<String, @Nullable Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static JSONPatchRequestAddReplaceTestMap	of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
String	op() must be one of ["add", "replace", "test"]
String	path()
@Nullable Object	value()

Op

public static class Op
extends JsonSchema

A schema class that validates payloads

Description

The operation to perform.

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

// String validation
String validatedPayload = JSONPatchRequestAddReplaceTest.Op.validate(
    "add",
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(     String.class )
Set	enumValues = SetMaker.makeSet(     "add",     "replace",     "test" )

Method Summary

Modifier and Type	Method and Description
String	validate(String arg, SchemaConfiguration configuration)
String	validate(StringOpEnums arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

StringOpEnums

public enum StringOpEnums
extends Enum<StringOpEnums>

A class that stores String enum values

Enum Constant Summary

Enum Constant	Description
ADD	value = "add"
REPLACE	value = "replace"
TEST	value = "test"

Value

public static class Value
extends AnyTypeJsonSchema

A schema class that validates payloads

Description

The value to add, replace or test.

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

Path

public static class Path
extends StringJsonSchema

A schema class that validates payloads

Description

A JSON Pointer path.

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

AdditionalProperties

public static class AdditionalProperties
extends NotAnyTypeJsonSchema

A schema class that validates payloads

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

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