ReadOnlyFirst.md

ReadOnlyFirst

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

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

Nested Class Summary

Modifier and Type	Class and Description
sealed interface	ReadOnlyFirst.ReadOnlyFirst1Boxed sealed interface for validated payloads
record	ReadOnlyFirst.ReadOnlyFirst1BoxedMap boxed class to store validated Map payloads
static class	ReadOnlyFirst.ReadOnlyFirst1 schema class
static class	ReadOnlyFirst.ReadOnlyFirstMapBuilder builder for Map payloads
static class	ReadOnlyFirst.ReadOnlyFirstMap output class for Map payloads
sealed interface	ReadOnlyFirst.BazBoxed sealed interface for validated payloads
record	ReadOnlyFirst.BazBoxedString boxed class to store validated String payloads
static class	ReadOnlyFirst.Baz schema class
sealed interface	ReadOnlyFirst.BarBoxed sealed interface for validated payloads
record	ReadOnlyFirst.BarBoxedString boxed class to store validated String payloads
static class	ReadOnlyFirst.Bar schema class

ReadOnlyFirst1Boxed

public sealed interface ReadOnlyFirst1Boxed
permits
ReadOnlyFirst1BoxedMap

sealed interface that stores validated payloads using boxed classes

ReadOnlyFirst1BoxedMap

public record ReadOnlyFirst1BoxedMap
implements ReadOnlyFirst1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ReadOnlyFirst1BoxedMap(ReadOnlyFirstMap data) Creates an instance, private visibility

Method Summary

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

ReadOnlyFirst1

public static class ReadOnlyFirst1
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.ReadOnlyFirst;

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

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

// Map validation
ReadOnlyFirst.ReadOnlyFirstMap validatedPayload =
    ReadOnlyFirst.ReadOnlyFirst1.validate(
    new ReadOnlyFirst.ReadOnlyFirstMapBuilder()
        .bar("a")

        .baz("a")

    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(Map.class)
Map<String, Class<? extends JsonSchema>>	properties = Map.ofEntries(     new PropertyEntry("bar", Bar.class)),     new PropertyEntry("baz", Baz.class)) )

Method Summary

Modifier and Type	Method and Description
ReadOnlyFirstMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
ReadOnlyFirst1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
ReadOnlyFirst1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ReadOnlyFirstMapBuilder

public class ReadOnlyFirstMapBuilder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
ReadOnlyFirstMapBuilder() Creates a builder that contains an empty map

Method Summary

Modifier and Type	Method and Description
Map<String, @Nullable Object>	build() Returns map input that should be used with Schema.validate
ReadOnlyFirstMapBuilder	bar(String value)
ReadOnlyFirstMapBuilder	baz(String value)
ReadOnlyFirstMapBuilder	additionalProperty(String key, Void value)
ReadOnlyFirstMapBuilder	additionalProperty(String key, boolean value)
ReadOnlyFirstMapBuilder	additionalProperty(String key, String value)
ReadOnlyFirstMapBuilder	additionalProperty(String key, int value)
ReadOnlyFirstMapBuilder	additionalProperty(String key, float value)
ReadOnlyFirstMapBuilder	additionalProperty(String key, long value)
ReadOnlyFirstMapBuilder	additionalProperty(String key, double value)
ReadOnlyFirstMapBuilder	additionalProperty(String key, List<?> value)
ReadOnlyFirstMapBuilder	additionalProperty(String key, Map<String, ?> value)

ReadOnlyFirstMap

public static class ReadOnlyFirstMap
extends FrozenMap<String, @Nullable Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static ReadOnlyFirstMap	of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
String	bar() [optional]
String	baz() [optional]
@Nullable Object	getAdditionalProperty(String name) provides type safety for additional properties

BazBoxed

public sealed interface BazBoxed
permits
BazBoxedString

sealed interface that stores validated payloads using boxed classes

BazBoxedString

public record BazBoxedString
implements BazBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Baz

public static class Baz
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.StringJsonSchema.StringJsonSchema1
validate
validateAndBox

BarBoxed

public sealed interface BarBoxed
permits
BarBoxedString

sealed interface that stores validated payloads using boxed classes

BarBoxedString

public record BarBoxedString
implements BarBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Bar

public static class Bar
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.StringJsonSchema.StringJsonSchema1
validate
validateAndBox

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