ObjectWithInlineCompositionProperty.md

ObjectWithInlineCompositionProperty

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

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	ObjectWithInlineCompositionProperty.ObjectWithInlineCompositionProperty1 schema class
static class	ObjectWithInlineCompositionProperty.ObjectWithInlineCompositionPropertyMapBuilder builder for Map payloads
static class	ObjectWithInlineCompositionProperty.ObjectWithInlineCompositionPropertyMap output class for Map payloads
static class	ObjectWithInlineCompositionProperty.SomeProp schema class
static class	ObjectWithInlineCompositionProperty.Schema0 schema class

ObjectWithInlineCompositionProperty1

public static class ObjectWithInlineCompositionProperty1
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
ObjectWithInlineCompositionProperty.ObjectWithInlineCompositionPropertyMap validatedPayload =
    ObjectWithInlineCompositionProperty.ObjectWithInlineCompositionProperty1.validate(
    new ObjectWithInlineCompositionProperty.ObjectWithInlineCompositionPropertyMapBuilder()
    .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)) )

Method Summary

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

ObjectWithInlineCompositionPropertyMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

ObjectWithInlineCompositionPropertyMap

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

A class to store validated Map payloads

Method Summary

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

SomeProp

public static class SomeProp
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type	Field and Description
List<Class<? extends JsonSchema>>	allOf = List.of(     Schema0.class ;)

Method Summary

Modifier and Type	Method and Description
String	validate(String arg, SchemaConfiguration configuration)
Void	validate(Void arg, SchemaConfiguration configuration)
int	validate(int arg, SchemaConfiguration configuration)
long	validate(long arg, SchemaConfiguration configuration)
float	validate(float arg, SchemaConfiguration configuration)
double	validate(double arg, SchemaConfiguration configuration)
boolean	validate(boolean arg, SchemaConfiguration configuration)
FrozenMap<String, @Nullable Object>	validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object>	validate(List<?> arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

Schema0

public static class Schema0
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());

// String validation
String validatedPayload = ObjectWithInlineCompositionProperty.Schema0.validate(
    "a",
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(     String.class )
Integer	minLength = 1

Method Summary

Modifier and Type	Method and Description
String	validate(String arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)
[Back to top] [Back to Component Schemas] [Back to README]