HasOnlyReadOnly.md

HasOnlyReadOnly

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

A class that contains necessary nested schema classes, and classes to store validated list and map payloads

Nested Class Summary

Modifier and Type	Class and Description
static class	HasOnlyReadOnly.HasOnlyReadOnly1 schema class
static class	HasOnlyReadOnly.HasOnlyReadOnlyMap output class for Map payloads
static class	HasOnlyReadOnly.Foo schema class
static class	HasOnlyReadOnly.Bar schema class

HasOnlyReadOnly1

public static class HasOnlyReadOnly1
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.MapMaker;
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
HasOnlyReadOnly.HasOnlyReadOnlyMap validatedPayload =
    HasOnlyReadOnly.HasOnlyReadOnly1.validate(
    MapMaker.makeMap(
        new AbstractMap.SimpleEntry<>(
            "bar",
            "a"
        ),
        new AbstractMap.SimpleEntry<>(
            "foo",
            "a"
        )
    ),
    configuration
);

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries(     new KeywordEntry("type", new TypeValidator(Set.of(FrozenMap.class))),     new KeywordEntry("properties", new PropertiesValidator(Map.ofEntries(         new PropertyEntry("bar", Bar.class)),         new PropertyEntry("foo", Foo.class))     ))) ));

Method Summary

Modifier and Type	Method and Description
static HasOnlyReadOnlyMap	validate(Map<String, Object> arg, SchemaConfiguration configuration)

HasOnlyReadOnlyMap

public static class HasOnlyReadOnlyMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static HasOnlyReadOnlyMap	of(Map<String, Object> arg, SchemaConfiguration configuration)
String	bar() [optional]
String	foo() [optional]
Object	getAdditionalProperty(String name) provides type safety for additional properties

Input Map Keys

type: Map<String, Object>

Key	Type	Description	Notes
bar	String		[optional]
foo	String		[optional]
anyStringName	Object	any string name can be used but the value must be the correct type	[optional]

Foo

public static class Foo
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]