BooleanEnum.md

BooleanEnum

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

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	BooleanEnum.BooleanEnum1Boxed sealed interface for validated payloads
record	BooleanEnum.BooleanEnum1BoxedBoolean boxed class to store validated boolean payloads
static class	BooleanEnum.BooleanEnum1 schema class
enum	BooleanEnum.BooleanBooleanEnumEnums boolean enum

BooleanEnum1Boxed

public sealed interface BooleanEnum1Boxed
permits
BooleanEnum1BoxedBoolean

sealed interface that stores validated payloads using boxed classes

BooleanEnum1BoxedBoolean

public record BooleanEnum1BoxedBoolean
implements BooleanEnum1Boxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

BooleanEnum1

public static class BooleanEnum1
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.BooleanEnum;

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

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

// boolean validation
boolean validatedPayload = BooleanEnum.BooleanEnum1.validate(
    true,
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(Boolean.class)
Set	enumValues = SetMaker.makeSet(     true )

Method Summary

Modifier and Type	Method and Description
boolean	validate(boolean arg, SchemaConfiguration configuration)
boolean	validate(BooleanBooleanEnumEnums arg, SchemaConfiguration configuration)
BooleanEnum1BoxedBoolean	validateAndBox(boolean arg, SchemaConfiguration configuration)
BooleanEnum1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

BooleanBooleanEnumEnums

public enum BooleanBooleanEnumEnums
extends Enum<BooleanBooleanEnumEnums>

A class that stores boolean enum values

Enum Constant Summary

Enum Constant	Description
TRUE	value = true

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