PropertiesWithNullValuedInstanceProperties.md

PropertiesWithNullValuedInstanceProperties

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

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	PropertiesWithNullValuedInstanceProperties.PropertiesWithNullValuedInstanceProperties1Boxed sealed interface for validated payloads
record	PropertiesWithNullValuedInstanceProperties.PropertiesWithNullValuedInstanceProperties1BoxedVoid boxed class to store validated null payloads
record	PropertiesWithNullValuedInstanceProperties.PropertiesWithNullValuedInstanceProperties1BoxedBoolean boxed class to store validated boolean payloads
record	PropertiesWithNullValuedInstanceProperties.PropertiesWithNullValuedInstanceProperties1BoxedNumber boxed class to store validated Number payloads
record	PropertiesWithNullValuedInstanceProperties.PropertiesWithNullValuedInstanceProperties1BoxedString boxed class to store validated String payloads
record	PropertiesWithNullValuedInstanceProperties.PropertiesWithNullValuedInstanceProperties1BoxedList boxed class to store validated List payloads
record	PropertiesWithNullValuedInstanceProperties.PropertiesWithNullValuedInstanceProperties1BoxedMap boxed class to store validated Map payloads
static class	PropertiesWithNullValuedInstanceProperties.PropertiesWithNullValuedInstanceProperties1 schema class
static class	PropertiesWithNullValuedInstanceProperties.PropertiesWithNullValuedInstancePropertiesMapBuilder builder for Map payloads
static class	PropertiesWithNullValuedInstanceProperties.PropertiesWithNullValuedInstancePropertiesMap output class for Map payloads
sealed interface	PropertiesWithNullValuedInstanceProperties.FooBoxed sealed interface for validated payloads
record	PropertiesWithNullValuedInstanceProperties.FooBoxedVoid boxed class to store validated null payloads
static class	PropertiesWithNullValuedInstanceProperties.Foo schema class

PropertiesWithNullValuedInstanceProperties1Boxed

public sealed interface PropertiesWithNullValuedInstanceProperties1Boxed
permits
PropertiesWithNullValuedInstanceProperties1BoxedVoid, PropertiesWithNullValuedInstanceProperties1BoxedBoolean, PropertiesWithNullValuedInstanceProperties1BoxedNumber, PropertiesWithNullValuedInstanceProperties1BoxedString, PropertiesWithNullValuedInstanceProperties1BoxedList, PropertiesWithNullValuedInstanceProperties1BoxedMap

sealed interface that stores validated payloads using boxed classes

PropertiesWithNullValuedInstanceProperties1BoxedVoid

public record PropertiesWithNullValuedInstanceProperties1BoxedVoid
implements PropertiesWithNullValuedInstanceProperties1Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

Constructor and Description
PropertiesWithNullValuedInstanceProperties1BoxedVoid(Void data) Creates an instance, private visibility

Method Summary

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

PropertiesWithNullValuedInstanceProperties1BoxedBoolean

public record PropertiesWithNullValuedInstanceProperties1BoxedBoolean
implements PropertiesWithNullValuedInstanceProperties1Boxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

Constructor and Description
PropertiesWithNullValuedInstanceProperties1BoxedBoolean(boolean data) Creates an instance, private visibility

Method Summary

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

PropertiesWithNullValuedInstanceProperties1BoxedNumber

public record PropertiesWithNullValuedInstanceProperties1BoxedNumber
implements PropertiesWithNullValuedInstanceProperties1Boxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

Constructor and Description
PropertiesWithNullValuedInstanceProperties1BoxedNumber(Number data) Creates an instance, private visibility

Method Summary

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

PropertiesWithNullValuedInstanceProperties1BoxedString

public record PropertiesWithNullValuedInstanceProperties1BoxedString
implements PropertiesWithNullValuedInstanceProperties1Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

PropertiesWithNullValuedInstanceProperties1BoxedList

public record PropertiesWithNullValuedInstanceProperties1BoxedList
implements PropertiesWithNullValuedInstanceProperties1Boxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
PropertiesWithNullValuedInstanceProperties1BoxedList(FrozenList<@Nullable Object> data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
FrozenList<@Nullable Object>	data() validated payload
@Nullable Object	getData() validated payload

PropertiesWithNullValuedInstanceProperties1BoxedMap

public record PropertiesWithNullValuedInstanceProperties1BoxedMap
implements PropertiesWithNullValuedInstanceProperties1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
PropertiesWithNullValuedInstanceProperties1BoxedMap(PropertiesWithNullValuedInstancePropertiesMap data) Creates an instance, private visibility

Method Summary

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

PropertiesWithNullValuedInstanceProperties1

public static class PropertiesWithNullValuedInstanceProperties1
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type	Field and Description
Map<String, Class<? extends JsonSchema>>	properties = Map.ofEntries(     new PropertyEntry("foo", Foo.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)
Number	validate(Number arg, SchemaConfiguration configuration)
boolean	validate(boolean arg, SchemaConfiguration configuration)
PropertiesWithNullValuedInstancePropertiesMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object>	validate(List<?> arg, SchemaConfiguration configuration)
PropertiesWithNullValuedInstanceProperties1BoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
PropertiesWithNullValuedInstanceProperties1BoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
PropertiesWithNullValuedInstanceProperties1BoxedNumber	validateAndBox(Number arg, SchemaConfiguration configuration)
PropertiesWithNullValuedInstanceProperties1BoxedBoolean	validateAndBox(boolean arg, SchemaConfiguration configuration)
PropertiesWithNullValuedInstanceProperties1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
PropertiesWithNullValuedInstanceProperties1BoxedList	validateAndBox(List<?> arg, SchemaConfiguration configuration)
PropertiesWithNullValuedInstanceProperties1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

PropertiesWithNullValuedInstancePropertiesMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

PropertiesWithNullValuedInstancePropertiesMap

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

A class to store validated Map payloads

Method Summary

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

FooBoxed

public sealed interface FooBoxed
permits
FooBoxedVoid

sealed interface that stores validated payloads using boxed classes

FooBoxedVoid

public record FooBoxedVoid
implements FooBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

Constructor and Description
FooBoxedVoid(Void data) Creates an instance, private visibility

Method Summary

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

Foo

public static class Foo
extends NullJsonSchema.NullJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.NullJsonSchema.NullJsonSchema1
validate
validateAndBox

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