ObjectWithOptionalTestProp.md

ObjectWithOptionalTestProp

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

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	ObjectWithOptionalTestProp.ObjectWithOptionalTestProp1 schema class
static class	ObjectWithOptionalTestProp.ObjectWithOptionalTestPropMapBuilder builder for Map payloads
static class	ObjectWithOptionalTestProp.ObjectWithOptionalTestPropMap output class for Map payloads
static class	ObjectWithOptionalTestProp.Test schema class

ObjectWithOptionalTestProp1

public static class ObjectWithOptionalTestProp1
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
ObjectWithOptionalTestProp.ObjectWithOptionalTestPropMap validatedPayload =
    ObjectWithOptionalTestProp.ObjectWithOptionalTestProp1.validate(
    new ObjectWithOptionalTestProp.ObjectWithOptionalTestPropMapBuilder()
        .test("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("test", Test.class)) )

Method Summary

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

ObjectWithOptionalTestPropMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

ObjectWithOptionalTestPropMap

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

A class to store validated Map payloads

Method Summary

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

Test

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