ObjectWithInlineCompositionProperty.md

ObjectWithInlineCompositionProperty

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

A class that contains necessary nested schema classes, and classes to store validated list and map payloads

Nested Class Summary

Modifier and Type	Class and Description
static class	ObjectWithInlineCompositionProperty.ObjectWithInlineCompositionProperty1 schema class
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.MapMaker;
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(
    MapMaker.makeMap(
    ),
    configuration
);

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries(     new KeywordEntry("type", new TypeValidator(Set.of(FrozenMap.class))),     new KeywordEntry("properties", new PropertiesValidator(Map.ofEntries(         new PropertyEntry("someProp", SomeProp.class))     ))) ));

Method Summary

Modifier and Type	Method and Description
static ObjectWithInlineCompositionPropertyMap	validate(Map<String, Object> arg, SchemaConfiguration configuration)

ObjectWithInlineCompositionPropertyMap

public static class ObjectWithInlineCompositionPropertyMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

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

Input Map Keys

type: Map<String, Object>

Key	Type	Description	Notes
someProp	Object		[optional]
anyStringName	Object	any string name can be used but the value must be the correct type	[optional]

SomeProp

public static class SomeProp
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries(     new KeywordEntry("allOf", new AllOfValidator(List.of(         Schema0.class     ))) ));

Method Summary

Modifier and Type	Method and Description
static String	validate(String arg, SchemaConfiguration configuration)
static Void	validate(Void arg, SchemaConfiguration configuration)
static int	validate(int arg, SchemaConfiguration configuration)
static long	validate(long arg, SchemaConfiguration configuration)
static float	validate(float arg, SchemaConfiguration configuration)
static double	validate(double arg, SchemaConfiguration configuration)
static boolean	validate(boolean arg, SchemaConfiguration configuration)
static FrozenMap<String, Object>	Map<String, Object> arg, SchemaConfiguration configuration)
FrozenList	validate(List 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.MapMaker;
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
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries(     new KeywordEntry("type", new TypeValidator(Set.of(         String.class     ))),     new KeywordEntry("minLength", new MinLengthValidator(1)) ));

Method Summary

Modifier and Type	Method and Description
static String	validate(String arg, SchemaConfiguration configuration)

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