Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Latest commit

 

History

History
314 lines (244 loc) · 12.7 KB

JSONPatchRequestMoveCopy.md

File metadata and controls

314 lines (244 loc) · 12.7 KB

JSONPatchRequestMoveCopy

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

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 JSONPatchRequestMoveCopy.JSONPatchRequestMoveCopy1
schema class
static class JSONPatchRequestMoveCopy.JSONPatchRequestMoveCopyMapBuilder
builder for Map payloads
static class JSONPatchRequestMoveCopy.JSONPatchRequestMoveCopyMap
output class for Map payloads
static class JSONPatchRequestMoveCopy.Op
schema class
enum JSONPatchRequestMoveCopy.StringOpEnums
String enum
static class JSONPatchRequestMoveCopy.Path
schema class
static class JSONPatchRequestMoveCopy.From
schema class
static class JSONPatchRequestMoveCopy.AdditionalProperties
schema class

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// 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)
@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()

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 = 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)
@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"

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

From

public static class From
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]