ArrayOfEnums.md

ArrayOfEnums

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

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 list payloads, extends FrozenList
• classes to build inputs for list payloads

Nested Class Summary

Modifier and Type	Class and Description
sealed interface	ArrayOfEnums.ArrayOfEnums1Boxed sealed interface for validated payloads
record	ArrayOfEnums.ArrayOfEnums1BoxedList boxed class to store validated List payloads
static class	ArrayOfEnums.ArrayOfEnums1 schema class
static class	ArrayOfEnums.ArrayOfEnumsListBuilder builder for List payloads
static class	ArrayOfEnums.ArrayOfEnumsList output class for List payloads

ArrayOfEnums1Boxed

public sealed interface ArrayOfEnums1Boxed
permits
ArrayOfEnums1BoxedList

sealed interface that stores validated payloads using boxed classes

ArrayOfEnums1BoxedList

public record ArrayOfEnums1BoxedList
implements ArrayOfEnums1Boxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ArrayOfEnums1BoxedList(ArrayOfEnumsList data) Creates an instance, private visibility

Method Summary

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

ArrayOfEnums1

public static class ArrayOfEnums1
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.ArrayOfEnums;

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

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

// List validation
ArrayOfEnums.ArrayOfEnumsList validatedPayload =
    ArrayOfEnums.ArrayOfEnums1.validate(
    new ArrayOfEnums.ArrayOfEnumsListBuilder()
        .add((Void) null)

    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(List.class)
Class<? extends JsonSchema>	items = StringEnum.StringEnum1.class

Method Summary

Modifier and Type	Method and Description
ArrayOfEnumsList	validate(List<?> arg, SchemaConfiguration configuration)
ArrayOfEnums1BoxedList	validateAndBox(List<?> arg, SchemaConfiguration configuration)
ArrayOfEnums1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ArrayOfEnumsListBuilder

public class ArrayOfEnumsListBuilder
builder for List<@Nullable String>

A class that builds the List input type

Constructor Summary

Constructor and Description
ArrayOfEnumsListBuilder() Creates an empty list
ArrayOfEnumsListBuilder(List<@Nullable String> items) Stores the items in a list

Method Summary

Modifier and Type	Method and Description
ArrayOfEnumsListBuilder	add(Void item)
ArrayOfEnumsListBuilder	add(String item)
ArrayOfEnumsListBuilder	add(StringEnum.StringStringEnumEnums item)
ArrayOfEnumsListBuilder	add(StringEnum.NullStringEnumEnums item)
List<@Nullable String>	build() Returns list input that should be used with Schema.validate

ArrayOfEnumsList

public class ArrayOfEnumsList
extends FrozenList<@Nullable String>

A class to store validated List payloads

Method Summary

Modifier and Type	Method and Description
static ArrayOfEnumsList	of(List<? extends @Nullable String> arg, SchemaConfiguration configuration)

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