ObjectWithOptionalTestProp.md

ObjectWithOptionalTestProp

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

A class that contains necessary nested

• schema classes (which validate payloads), extends JsonSchema
• sealed interfaces which store validated payloads, java version of a sum type
• boxed classes which store validated payloads, sealed permits class implementations
• classes to store validated map payloads, extends FrozenMap
• classes to build inputs for map payloads

Nested Class Summary

Modifier and Type	Class and Description
sealed interface	ObjectWithOptionalTestProp.ObjectWithOptionalTestProp1Boxed sealed interface for validated payloads
record	ObjectWithOptionalTestProp.ObjectWithOptionalTestProp1BoxedMap boxed class to store validated Map payloads
static class	ObjectWithOptionalTestProp.ObjectWithOptionalTestProp1 schema class
static class	ObjectWithOptionalTestProp.ObjectWithOptionalTestPropMapBuilder builder for Map payloads
static class	ObjectWithOptionalTestProp.ObjectWithOptionalTestPropMap output class for Map payloads
sealed interface	ObjectWithOptionalTestProp.TestBoxed sealed interface for validated payloads
record	ObjectWithOptionalTestProp.TestBoxedString boxed class to store validated String payloads
static class	ObjectWithOptionalTestProp.Test schema class

ObjectWithOptionalTestProp1Boxed

public sealed interface ObjectWithOptionalTestProp1Boxed
permits
ObjectWithOptionalTestProp1BoxedMap

sealed interface that stores validated payloads using boxed classes

ObjectWithOptionalTestProp1BoxedMap

public record ObjectWithOptionalTestProp1BoxedMap
implements ObjectWithOptionalTestProp1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ObjectWithOptionalTestProp1BoxedMap(ObjectWithOptionalTestPropMap data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
ObjectWithOptionalTestPropMap	data() validated payload
@Nullable Object	getData() validated payload

ObjectWithOptionalTestProp1

public static class ObjectWithOptionalTestProp1
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 org.openapijsonschematools.client.components.schemas.ObjectWithOptionalTestProp;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());

// Map validation
ObjectWithOptionalTestProp.ObjectWithOptionalTestPropMap validatedPayload =
    ObjectWithOptionalTestProp.ObjectWithOptionalTestProp1.validate(
    new ObjectWithOptionalTestProp.ObjectWithOptionalTestPropMapBuilder()
        .test("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("test", Test.class)) )

Method Summary

Modifier and Type	Method and Description
ObjectWithOptionalTestPropMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
ObjectWithOptionalTestProp1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
ObjectWithOptionalTestProp1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ObjectWithOptionalTestPropMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

ObjectWithOptionalTestPropMap

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

A class to store validated Map payloads

Method Summary

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

TestBoxed

public sealed interface TestBoxed
permits
TestBoxedString

sealed interface that stores validated payloads using boxed classes

TestBoxedString

public record TestBoxedString
implements TestBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

Constructor and Description
TestBoxedString(String data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
String	data() validated payload
@Nullable Object	getData() validated payload

Test

public static class Test
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

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

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