StringEnumWithDefaultValue.md

StringEnumWithDefaultValue

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

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
• enum classes

Nested Class Summary

Modifier and Type	Class and Description
sealed interface	StringEnumWithDefaultValue.StringEnumWithDefaultValue1Boxed sealed interface for validated payloads
record	StringEnumWithDefaultValue.StringEnumWithDefaultValue1BoxedString boxed class to store validated String payloads
static class	StringEnumWithDefaultValue.StringEnumWithDefaultValue1 schema class
enum	StringEnumWithDefaultValue.StringStringEnumWithDefaultValueEnums String enum

StringEnumWithDefaultValue1Boxed

public sealed interface StringEnumWithDefaultValue1Boxed
permits
StringEnumWithDefaultValue1BoxedString

sealed interface that stores validated payloads using boxed classes

StringEnumWithDefaultValue1BoxedString

public record StringEnumWithDefaultValue1BoxedString
implements StringEnumWithDefaultValue1Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

StringEnumWithDefaultValue1

public static class StringEnumWithDefaultValue1
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.StringEnumWithDefaultValue;

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 = StringEnumWithDefaultValue.StringEnumWithDefaultValue1.validate(
    "placed",
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(     String.class )
Set	enumValues = SetMaker.makeSet(     "placed",     "approved",     "delivered" )
@Nullable Object	defaultValue = "placed"

Method Summary

Modifier and Type	Method and Description
String	validate(String arg, SchemaConfiguration configuration)
String	validate(StringStringEnumWithDefaultValueEnums arg, SchemaConfiguration configuration)
StringEnumWithDefaultValue1BoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
StringEnumWithDefaultValue1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

StringStringEnumWithDefaultValueEnums

public enum StringStringEnumWithDefaultValueEnums
extends Enum<StringStringEnumWithDefaultValueEnums>

A class that stores String enum values

Enum Constant Summary

Enum Constant	Description
PLACED	value = "placed"
APPROVED	value = "approved"
DELIVERED	value = "delivered"

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