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

Latest commit

 

History

History
437 lines (342 loc) · 18.3 KB

JSONPatchRequestRemove.md

File metadata and controls

437 lines (342 loc) · 18.3 KB

JSONPatchRequestRemove

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

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 JSONPatchRequestRemove.JSONPatchRequestRemove1Boxed
sealed interface for validated payloads
record JSONPatchRequestRemove.JSONPatchRequestRemove1BoxedMap
boxed class to store validated Map payloads
static class JSONPatchRequestRemove.JSONPatchRequestRemove1
schema class
static class JSONPatchRequestRemove.JSONPatchRequestRemoveMapBuilder
builder for Map payloads
static class JSONPatchRequestRemove.JSONPatchRequestRemoveMap
output class for Map payloads
sealed interface JSONPatchRequestRemove.OpBoxed
sealed interface for validated payloads
record JSONPatchRequestRemove.OpBoxedString
boxed class to store validated String payloads
static class JSONPatchRequestRemove.Op
schema class
enum JSONPatchRequestRemove.StringOpEnums
String enum
sealed interface JSONPatchRequestRemove.PathBoxed
sealed interface for validated payloads
record JSONPatchRequestRemove.PathBoxedString
boxed class to store validated String payloads
static class JSONPatchRequestRemove.Path
schema class
sealed interface JSONPatchRequestRemove.AdditionalPropertiesBoxed
sealed interface for validated payloads
record JSONPatchRequestRemove.AdditionalPropertiesBoxedVoid
boxed class to store validated null payloads
record JSONPatchRequestRemove.AdditionalPropertiesBoxedBoolean
boxed class to store validated boolean payloads
record JSONPatchRequestRemove.AdditionalPropertiesBoxedNumber
boxed class to store validated Number payloads
record JSONPatchRequestRemove.AdditionalPropertiesBoxedString
boxed class to store validated String payloads
record JSONPatchRequestRemove.AdditionalPropertiesBoxedList
boxed class to store validated List payloads
record JSONPatchRequestRemove.AdditionalPropertiesBoxedMap
boxed class to store validated Map payloads
static class JSONPatchRequestRemove.AdditionalProperties
schema class

JSONPatchRequestRemove1Boxed

public sealed interface JSONPatchRequestRemove1Boxed
permits
JSONPatchRequestRemove1BoxedMap

sealed interface that stores validated payloads using boxed classes

JSONPatchRequestRemove1BoxedMap

public record JSONPatchRequestRemove1BoxedMap
implements JSONPatchRequestRemove1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
JSONPatchRequestRemove1BoxedMap(JSONPatchRequestRemoveMap data)
Creates an instance, private visibility

Method Summary

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

JSONPatchRequestRemove1

public static class JSONPatchRequestRemove1
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.JSONPatchRequestRemove;

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

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

// Map validation
JSONPatchRequestRemove.JSONPatchRequestRemoveMap validatedPayload =
    JSONPatchRequestRemove.JSONPatchRequestRemove1.validate(
    new JSONPatchRequestRemove.JSONPatchRequestRemoveMapBuilder()
        .op("remove")

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

Method Summary

Modifier and Type Method and Description
JSONPatchRequestRemoveMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
JSONPatchRequestRemove1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
JSONPatchRequestRemove1Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

JSONPatchRequestRemoveMap00Builder

public class JSONPatchRequestRemoveMap00Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
JSONPatchRequestRemoveMap00Builder(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

JSONPatchRequestRemoveMap01Builder

public class JSONPatchRequestRemoveMap01Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

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

Method Summary

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

JSONPatchRequestRemoveMap10Builder

public class JSONPatchRequestRemoveMap10Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

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

Method Summary

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

JSONPatchRequestRemoveMapBuilder

public class JSONPatchRequestRemoveMapBuilder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type Method and Description
JSONPatchRequestRemoveMap01Builder op(String value)
JSONPatchRequestRemoveMap01Builder op(StringOpEnums value)
JSONPatchRequestRemoveMap10Builder path(String value)

JSONPatchRequestRemoveMap

public static class JSONPatchRequestRemoveMap
extends FrozenMap<String, String>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static JSONPatchRequestRemoveMap of(Map<String, String> arg, SchemaConfiguration configuration)
String op()
must be one of ["remove"]
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.JSONPatchRequestRemove;

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 = JSONPatchRequestRemove.Op.validate(
    "remove",
    configuration
);

Field Summary

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

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
REMOVE value = "remove"

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

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]