Client.md

Client

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

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	Client.Client1 schema class
static class	Client.ClientMapBuilder1 builder for Map payloads
static class	Client.ClientMap output class for Map payloads
static class	Client.Client2 schema class

Client1

public static class Client1
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
Client.ClientMap validatedPayload =
    Client.Client1.validate(
    new Client.ClientMapBuilder1()
        .client("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("client", Client2.class)) )

Method Summary

Modifier and Type	Method and Description
ClientMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ClientMapBuilder1

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
ClientMapBuilder1() 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
ClientMapBuilder1	client(String value)
ClientMapBuilder1	additionalProperty(String key, Void value)
ClientMapBuilder1	additionalProperty(String key, boolean value)
ClientMapBuilder1	additionalProperty(String key, String value)
ClientMapBuilder1	additionalProperty(String key, int value)
ClientMapBuilder1	additionalProperty(String key, float value)
ClientMapBuilder1	additionalProperty(String key, long value)
ClientMapBuilder1	additionalProperty(String key, double value)
ClientMapBuilder1	additionalProperty(String key, List<?> value)
ClientMapBuilder1	additionalProperty(String key, Map<String, ?> value)

ClientMap

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

A class to store validated Map payloads

Method Summary

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

Client2

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