JSONPatchRequestMoveCopy.md

JSONPatchRequestMoveCopy

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

A class that contains necessary nested

• schema classes (which validate payloads), extends JsonSchema
• sealed interfaces which store validated payloads, java version of a sum type
• boxed classes which store validated payloads, sealed permits class implementations
• 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
sealed interface	JSONPatchRequestMoveCopy.JSONPatchRequestMoveCopy1Boxed sealed interface for validated payloads
record	JSONPatchRequestMoveCopy.JSONPatchRequestMoveCopy1BoxedMap boxed class to store validated Map payloads
static class	JSONPatchRequestMoveCopy.JSONPatchRequestMoveCopy1 schema class
static class	JSONPatchRequestMoveCopy.JSONPatchRequestMoveCopyMapBuilder builder for Map payloads
static class	JSONPatchRequestMoveCopy.JSONPatchRequestMoveCopyMap output class for Map payloads
sealed interface	JSONPatchRequestMoveCopy.OpBoxed sealed interface for validated payloads
record	JSONPatchRequestMoveCopy.OpBoxedString boxed class to store validated String payloads
static class	JSONPatchRequestMoveCopy.Op schema class
enum	JSONPatchRequestMoveCopy.StringOpEnums String enum
sealed interface	JSONPatchRequestMoveCopy.PathBoxed sealed interface for validated payloads
record	JSONPatchRequestMoveCopy.PathBoxedString boxed class to store validated String payloads
static class	JSONPatchRequestMoveCopy.Path schema class
sealed interface	JSONPatchRequestMoveCopy.FromBoxed sealed interface for validated payloads
record	JSONPatchRequestMoveCopy.FromBoxedString boxed class to store validated String payloads
static class	JSONPatchRequestMoveCopy.From schema class
sealed interface	JSONPatchRequestMoveCopy.AdditionalPropertiesBoxed sealed interface for validated payloads
record	JSONPatchRequestMoveCopy.AdditionalPropertiesBoxedVoid boxed class to store validated null payloads
record	JSONPatchRequestMoveCopy.AdditionalPropertiesBoxedBoolean boxed class to store validated boolean payloads
record	JSONPatchRequestMoveCopy.AdditionalPropertiesBoxedNumber boxed class to store validated Number payloads
record	JSONPatchRequestMoveCopy.AdditionalPropertiesBoxedString boxed class to store validated String payloads
record	JSONPatchRequestMoveCopy.AdditionalPropertiesBoxedList boxed class to store validated List payloads
record	JSONPatchRequestMoveCopy.AdditionalPropertiesBoxedMap boxed class to store validated Map payloads
static class	JSONPatchRequestMoveCopy.AdditionalProperties schema class

JSONPatchRequestMoveCopy1Boxed

public sealed interface JSONPatchRequestMoveCopy1Boxed
permits
JSONPatchRequestMoveCopy1BoxedMap

sealed interface that stores validated payloads using boxed classes

JSONPatchRequestMoveCopy1BoxedMap

public record JSONPatchRequestMoveCopy1BoxedMap
implements JSONPatchRequestMoveCopy1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
JSONPatchRequestMoveCopy1BoxedMap(JSONPatchRequestMoveCopyMap data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestMoveCopyMap	data() validated payload
@Nullable Object	getData() validated payload

JSONPatchRequestMoveCopy1

public static class JSONPatchRequestMoveCopy1
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 org.openapijsonschematools.client.components.schemas.JSONPatchRequestMoveCopy;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());

// Map validation
JSONPatchRequestMoveCopy.JSONPatchRequestMoveCopyMap validatedPayload =
    JSONPatchRequestMoveCopy.JSONPatchRequestMoveCopy1.validate(
    new JSONPatchRequestMoveCopy.JSONPatchRequestMoveCopyMapBuilder()
        .from("a")

        .op("move")

        .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("from", From.class)),     new PropertyEntry("path", Path.class)),     new PropertyEntry("op", Op.class)) )
Set	required = Set.of(     "from",     "op",     "path" )
Class<? extends JsonSchema>	additionalProperties = AdditionalProperties.class

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestMoveCopyMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
JSONPatchRequestMoveCopy1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
JSONPatchRequestMoveCopy1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

JSONPatchRequestMoveCopyMap000Builder

public class JSONPatchRequestMoveCopyMap000Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestMoveCopyMap000Builder(Map<String, String> instance) Creates a builder that contains the passed instance

Method Summary

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

JSONPatchRequestMoveCopyMap001Builder

public class JSONPatchRequestMoveCopyMap001Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestMoveCopyMap001Builder(Map<String, String> instance) Creates a builder that contains the passed instance

Method Summary

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

JSONPatchRequestMoveCopyMap010Builder

public class JSONPatchRequestMoveCopyMap010Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestMoveCopyMap010Builder(Map<String, String> instance) Creates a builder that contains the passed instance

Method Summary

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

JSONPatchRequestMoveCopyMap011Builder

public class JSONPatchRequestMoveCopyMap011Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestMoveCopyMap011Builder(Map<String, String> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestMoveCopyMap001Builder	op(String value)
JSONPatchRequestMoveCopyMap001Builder	op(StringOpEnums value)
JSONPatchRequestMoveCopyMap010Builder	path(String value)

JSONPatchRequestMoveCopyMap100Builder

public class JSONPatchRequestMoveCopyMap100Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestMoveCopyMap100Builder(Map<String, String> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestMoveCopyMap000Builder	from(String value)

JSONPatchRequestMoveCopyMap101Builder

public class JSONPatchRequestMoveCopyMap101Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestMoveCopyMap101Builder(Map<String, String> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestMoveCopyMap001Builder	from(String value)
JSONPatchRequestMoveCopyMap100Builder	path(String value)

JSONPatchRequestMoveCopyMap110Builder

public class JSONPatchRequestMoveCopyMap110Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestMoveCopyMap110Builder(Map<String, String> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestMoveCopyMap010Builder	from(String value)
JSONPatchRequestMoveCopyMap100Builder	op(String value)
JSONPatchRequestMoveCopyMap100Builder	op(StringOpEnums value)

JSONPatchRequestMoveCopyMapBuilder

public class JSONPatchRequestMoveCopyMapBuilder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
JSONPatchRequestMoveCopyMap011Builder	from(String value)
JSONPatchRequestMoveCopyMap101Builder	op(String value)
JSONPatchRequestMoveCopyMap101Builder	op(StringOpEnums value)
JSONPatchRequestMoveCopyMap110Builder	path(String value)

JSONPatchRequestMoveCopyMap

public static class JSONPatchRequestMoveCopyMap
extends FrozenMap<String, String>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static JSONPatchRequestMoveCopyMap	of(Map<String, String> arg, SchemaConfiguration configuration)
String	from()
String	op() must be one of ["move", "copy"]
String	path()

OpBoxed

public sealed interface OpBoxed
permits
OpBoxedString

sealed interface that stores validated payloads using boxed classes

OpBoxedString

public record OpBoxedString
implements OpBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

Constructor and Description
OpBoxedString(String data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
String	data() validated payload
@Nullable Object	getData() validated payload

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 org.openapijsonschematools.client.components.schemas.JSONPatchRequestMoveCopy;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());

// String validation
String validatedPayload = JSONPatchRequestMoveCopy.Op.validate(
    "move",
    configuration
);

Field Summary

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

Method Summary

Modifier and Type	Method and Description
String	validate(String arg, SchemaConfiguration configuration)
String	validate(StringOpEnums arg, SchemaConfiguration configuration)
OpBoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
OpBoxed	validateAndBox(@Nullable Object 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
MOVE	value = "move"
COPY	value = "copy"

PathBoxed

public sealed interface PathBoxed
permits
PathBoxedString

sealed interface that stores validated payloads using boxed classes

PathBoxedString

public record PathBoxedString
implements PathBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

Constructor and Description
PathBoxedString(String data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
String	data() validated payload
@Nullable Object	getData() validated payload

Path

public static class Path
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

Description

A JSON Pointer path.

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

FromBoxed

public sealed interface FromBoxed
permits
FromBoxedString

sealed interface that stores validated payloads using boxed classes

FromBoxedString

public record FromBoxedString
implements FromBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

Constructor and Description
FromBoxedString(String data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
String	data() validated payload
@Nullable Object	getData() validated payload

From

public static class From
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

Description

A JSON Pointer path.

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

AdditionalPropertiesBoxed

public sealed interface AdditionalPropertiesBoxed
permits
AdditionalPropertiesBoxedVoid, AdditionalPropertiesBoxedBoolean, AdditionalPropertiesBoxedNumber, AdditionalPropertiesBoxedString, AdditionalPropertiesBoxedList, AdditionalPropertiesBoxedMap

sealed interface that stores validated payloads using boxed classes

AdditionalPropertiesBoxedVoid

public record AdditionalPropertiesBoxedVoid
implements AdditionalPropertiesBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedVoid(Void data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
Void	data() validated payload
@Nullable Object	getData() validated payload

AdditionalPropertiesBoxedBoolean

public record AdditionalPropertiesBoxedBoolean
implements AdditionalPropertiesBoxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedBoolean(boolean data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
boolean	data() validated payload
@Nullable Object	getData() validated payload

AdditionalPropertiesBoxedNumber

public record AdditionalPropertiesBoxedNumber
implements AdditionalPropertiesBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedNumber(Number data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
Number	data() validated payload
@Nullable Object	getData() validated payload

AdditionalPropertiesBoxedString

public record AdditionalPropertiesBoxedString
implements AdditionalPropertiesBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedString(String data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
String	data() validated payload
@Nullable Object	getData() validated payload

AdditionalPropertiesBoxedList

public record AdditionalPropertiesBoxedList
implements AdditionalPropertiesBoxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedList(FrozenList<@Nullable Object> data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
FrozenList<@Nullable Object>	data() validated payload
@Nullable Object	getData() validated payload

AdditionalPropertiesBoxedMap

public record AdditionalPropertiesBoxedMap
implements AdditionalPropertiesBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedMap(FrozenMap<@Nullable Object> data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
FrozenMap<@Nullable Object>	data() validated payload
@Nullable Object	getData() validated payload

AdditionalProperties

public static class AdditionalProperties
extends NotAnyTypeJsonSchema.NotAnyTypeJsonSchema1

A schema class that validates payloads

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

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