StringWithValidation.md

StringWithValidation

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

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	StringWithValidation.StringWithValidation1Boxed sealed interface for validated payloads
record	StringWithValidation.StringWithValidation1BoxedString boxed class to store validated String payloads
static class	StringWithValidation.StringWithValidation1 schema class

StringWithValidation1Boxed

public sealed interface StringWithValidation1Boxed
permits
StringWithValidation1BoxedString

sealed interface that stores validated payloads using boxed classes

StringWithValidation1BoxedString

public record StringWithValidation1BoxedString
implements StringWithValidation1Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

StringWithValidation1

public static class StringWithValidation1
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.StringWithValidation;

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

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

// String validation
String validatedPayload = StringWithValidation.StringWithValidation1.validate(
    "a",
    configuration
);

Field Summary

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

Method Summary

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

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