JsonPointerFormat.md

JsonPointerFormat

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

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

Nested Class Summary

Modifier and Type	Class and Description
sealed interface	JsonPointerFormat.JsonPointerFormat1Boxed sealed interface for validated payloads
record	JsonPointerFormat.JsonPointerFormat1BoxedVoid boxed class to store validated null payloads
record	JsonPointerFormat.JsonPointerFormat1BoxedBoolean boxed class to store validated boolean payloads
record	JsonPointerFormat.JsonPointerFormat1BoxedNumber boxed class to store validated Number payloads
record	JsonPointerFormat.JsonPointerFormat1BoxedString boxed class to store validated String payloads
record	JsonPointerFormat.JsonPointerFormat1BoxedList boxed class to store validated List payloads
record	JsonPointerFormat.JsonPointerFormat1BoxedMap boxed class to store validated Map payloads
static class	JsonPointerFormat.JsonPointerFormat1 schema class

JsonPointerFormat1Boxed

public sealed interface JsonPointerFormat1Boxed
permits
JsonPointerFormat1BoxedVoid, JsonPointerFormat1BoxedBoolean, JsonPointerFormat1BoxedNumber, JsonPointerFormat1BoxedString, JsonPointerFormat1BoxedList, JsonPointerFormat1BoxedMap

sealed interface that stores validated payloads using boxed classes

JsonPointerFormat1BoxedVoid

public record JsonPointerFormat1BoxedVoid
implements JsonPointerFormat1Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

JsonPointerFormat1BoxedBoolean

public record JsonPointerFormat1BoxedBoolean
implements JsonPointerFormat1Boxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

JsonPointerFormat1BoxedNumber

public record JsonPointerFormat1BoxedNumber
implements JsonPointerFormat1Boxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

JsonPointerFormat1BoxedString

public record JsonPointerFormat1BoxedString
implements JsonPointerFormat1Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

JsonPointerFormat1BoxedList

public record JsonPointerFormat1BoxedList
implements JsonPointerFormat1Boxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

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

JsonPointerFormat1BoxedMap

public record JsonPointerFormat1BoxedMap
implements JsonPointerFormat1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

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

JsonPointerFormat1

public static class JsonPointerFormat1
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type	Field and Description
String	type = "json-pointer";

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)
Number	validate(Number arg, SchemaConfiguration configuration)
boolean	validate(boolean arg, SchemaConfiguration configuration)
FrozenMap<@Nullable Object>	validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object>	validate(List<?> arg, SchemaConfiguration configuration)
JsonPointerFormat1BoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
JsonPointerFormat1BoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
JsonPointerFormat1BoxedNumber	validateAndBox(Number arg, SchemaConfiguration configuration)
JsonPointerFormat1BoxedBoolean	validateAndBox(boolean arg, SchemaConfiguration configuration)
JsonPointerFormat1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
JsonPointerFormat1BoxedList	validateAndBox(List<?> arg, SchemaConfiguration configuration)
JsonPointerFormat1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

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