UUIDString.md

UUIDString

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

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	UUIDString.UUIDString1Boxed sealed interface for validated payloads
record	UUIDString.UUIDString1BoxedString boxed class to store validated String payloads
static class	UUIDString.UUIDString1 schema class

UUIDString1Boxed

public sealed interface UUIDString1Boxed
permits
UUIDString1BoxedString

sealed interface that stores validated payloads using boxed classes

UUIDString1BoxedString

public record UUIDString1BoxedString
implements UUIDString1Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

UUIDString1

public static class UUIDString1
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.UUIDString;

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 = UUIDString.UUIDString1.validate(
    "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(     String.class )
String	type = "uuid";
Integer	minLength = 1

Method Summary

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

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