ObjectWithOnlyOptionalProps.md

ObjectWithOnlyOptionalProps

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

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	ObjectWithOnlyOptionalProps.ObjectWithOnlyOptionalProps1 schema class
static class	ObjectWithOnlyOptionalProps.ObjectWithOnlyOptionalPropsMapBuilder builder for Map payloads
static class	ObjectWithOnlyOptionalProps.ObjectWithOnlyOptionalPropsMap output class for Map payloads
static class	ObjectWithOnlyOptionalProps.B schema class
static class	ObjectWithOnlyOptionalProps.A schema class
static class	ObjectWithOnlyOptionalProps.AdditionalProperties schema class

ObjectWithOnlyOptionalProps1

public static class ObjectWithOnlyOptionalProps1
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
ObjectWithOnlyOptionalProps.ObjectWithOnlyOptionalPropsMap validatedPayload =
    ObjectWithOnlyOptionalProps.ObjectWithOnlyOptionalProps1.validate(
    new ObjectWithOnlyOptionalProps.ObjectWithOnlyOptionalPropsMapBuilder()
        .a("a")

        .b(1)

    .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("a", A.class)),     new PropertyEntry("b", B.class)) )
Class<? extends JsonSchema>	additionalProperties = AdditionalProperties.class

Method Summary

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

ObjectWithOnlyOptionalPropsMapBuilder

public class ObjectWithOnlyOptionalPropsMapBuilder
builder for Map<String, Object>

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Map<String, Object>	build() Returns map input that should be used with Schema.validate
ObjectWithOnlyOptionalPropsMapBuilder	a(String value)
ObjectWithOnlyOptionalPropsMapBuilder	b(int value)
ObjectWithOnlyOptionalPropsMapBuilder	b(float value)
ObjectWithOnlyOptionalPropsMapBuilder	b(long value)
ObjectWithOnlyOptionalPropsMapBuilder	b(double value)

ObjectWithOnlyOptionalPropsMap

public static class ObjectWithOnlyOptionalPropsMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static ObjectWithOnlyOptionalPropsMap	of(Map<String, Object> arg, SchemaConfiguration configuration)
String	a() [optional]
Number	b() [optional]

B

public static class B
extends NumberJsonSchema

A schema class that validates payloads

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

A

public static class A
extends StringJsonSchema

A schema class that validates payloads

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

AdditionalProperties

public static class AdditionalProperties
extends NotAnyTypeJsonSchema

A schema class that validates payloads

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

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