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

Nested Class Summary

Modifier and Type	Class and Description
static class	ReadOnlyFirst.ReadOnlyFirst1 schema class
static class	ReadOnlyFirst.ReadOnlyFirstMapBuilder builder for Map payloads
static class	ReadOnlyFirst.ReadOnlyFirstMap output class for Map payloads
static class	ReadOnlyFirst.Baz schema class
static class	ReadOnlyFirst.Bar schema class

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

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

// 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)
@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

Baz

public static class Baz
extends StringJsonSchema

A schema class that validates payloads

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

Bar

public static class Bar
extends StringJsonSchema

A schema class that validates payloads

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

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