ObjectModelWithArgAndArgsProperties.md

ObjectModelWithArgAndArgsProperties

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

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	ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsProperties1 schema class
static class	ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsPropertiesMapBuilder builder for Map payloads
static class	ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsPropertiesMap output class for Map payloads
static class	ObjectModelWithArgAndArgsProperties.Args schema class
static class	ObjectModelWithArgAndArgsProperties.Arg schema class

ObjectModelWithArgAndArgsProperties1

public static class ObjectModelWithArgAndArgsProperties1
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
ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsPropertiesMap validatedPayload =
    ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsProperties1.validate(
    new ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsPropertiesMapBuilder()
        .arg("a")

        .args("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("arg", Arg.class)),     new PropertyEntry("args", Args.class)) )
Set	required = Set.of(     "arg",     "args" )

Method Summary

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

ObjectModelWithArgAndArgsPropertiesMap00Builder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
ObjectModelWithArgAndArgsPropertiesMap00Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
Map<String, @Nullable Object>	build() Returns map input that should be used with Schema.validate
ObjectModelWithArgAndArgsPropertiesMap00Builder	additionalProperty(String key, Void value)
ObjectModelWithArgAndArgsPropertiesMap00Builder	additionalProperty(String key, boolean value)
ObjectModelWithArgAndArgsPropertiesMap00Builder	additionalProperty(String key, String value)
ObjectModelWithArgAndArgsPropertiesMap00Builder	additionalProperty(String key, int value)
ObjectModelWithArgAndArgsPropertiesMap00Builder	additionalProperty(String key, float value)
ObjectModelWithArgAndArgsPropertiesMap00Builder	additionalProperty(String key, long value)
ObjectModelWithArgAndArgsPropertiesMap00Builder	additionalProperty(String key, double value)
ObjectModelWithArgAndArgsPropertiesMap00Builder	additionalProperty(String key, List<?> value)
ObjectModelWithArgAndArgsPropertiesMap00Builder	additionalProperty(String key, Map<String, ?> value)

ObjectModelWithArgAndArgsPropertiesMap01Builder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
ObjectModelWithArgAndArgsPropertiesMap01Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
ObjectModelWithArgAndArgsPropertiesMap00Builder	args(String value)

ObjectModelWithArgAndArgsPropertiesMap10Builder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
ObjectModelWithArgAndArgsPropertiesMap10Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
ObjectModelWithArgAndArgsPropertiesMap00Builder	arg(String value)

ObjectModelWithArgAndArgsPropertiesMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
ObjectModelWithArgAndArgsPropertiesMap01Builder	arg(String value)
ObjectModelWithArgAndArgsPropertiesMap10Builder	args(String value)

ObjectModelWithArgAndArgsPropertiesMap

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

A class to store validated Map payloads

Method Summary

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

Args

public static class Args
extends StringJsonSchema

A schema class that validates payloads

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

Arg

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