ObjectWithCollidingProperties.md

ObjectWithCollidingProperties

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

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	ObjectWithCollidingProperties.ObjectWithCollidingProperties1 schema class
static class	ObjectWithCollidingProperties.ObjectWithCollidingPropertiesMapBuilder builder for Map payloads
static class	ObjectWithCollidingProperties.ObjectWithCollidingPropertiesMap output class for Map payloads
static class	ObjectWithCollidingProperties.Someprop schema class
static class	ObjectWithCollidingProperties.SomeProp schema class

ObjectWithCollidingProperties1

public static class ObjectWithCollidingProperties1
extends JsonSchema

A schema class that validates payloads

Description

component with properties that have name collisions

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
ObjectWithCollidingProperties.ObjectWithCollidingPropertiesMap validatedPayload =
    ObjectWithCollidingProperties.ObjectWithCollidingProperties1.validate(
    new ObjectWithCollidingProperties.ObjectWithCollidingPropertiesMapBuilder()
    .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("someProp", SomeProp.class)),     new PropertyEntry("someprop", Someprop.class)) )

Method Summary

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

ObjectWithCollidingPropertiesMapBuilder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
ObjectWithCollidingPropertiesMapBuilder() 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
ObjectWithCollidingPropertiesMapBuilder	someProp(Map<String, @Nullable Object> value)
ObjectWithCollidingPropertiesMapBuilder	someprop(Map<String, @Nullable Object> value)
ObjectWithCollidingPropertiesMapBuilder	additionalProperty(String key, Void value)
ObjectWithCollidingPropertiesMapBuilder	additionalProperty(String key, boolean value)
ObjectWithCollidingPropertiesMapBuilder	additionalProperty(String key, String value)
ObjectWithCollidingPropertiesMapBuilder	additionalProperty(String key, int value)
ObjectWithCollidingPropertiesMapBuilder	additionalProperty(String key, float value)
ObjectWithCollidingPropertiesMapBuilder	additionalProperty(String key, long value)
ObjectWithCollidingPropertiesMapBuilder	additionalProperty(String key, double value)
ObjectWithCollidingPropertiesMapBuilder	additionalProperty(String key, List<?> value)
ObjectWithCollidingPropertiesMapBuilder	additionalProperty(String key, Map<String, ?> value)

ObjectWithCollidingPropertiesMap

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

A class to store validated Map payloads

Method Summary

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

Someprop

public static class Someprop
extends MapJsonSchema

A schema class that validates payloads

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

SomeProp

public static class SomeProp
extends MapJsonSchema

A schema class that validates payloads

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

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