RequiredValidation.md

RequiredValidation

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

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	RequiredValidation.RequiredValidation1Boxed sealed interface for validated payloads
record	RequiredValidation.RequiredValidation1BoxedVoid boxed class to store validated null payloads
record	RequiredValidation.RequiredValidation1BoxedBoolean boxed class to store validated boolean payloads
record	RequiredValidation.RequiredValidation1BoxedNumber boxed class to store validated Number payloads
record	RequiredValidation.RequiredValidation1BoxedString boxed class to store validated String payloads
record	RequiredValidation.RequiredValidation1BoxedList boxed class to store validated List payloads
record	RequiredValidation.RequiredValidation1BoxedMap boxed class to store validated Map payloads
static class	RequiredValidation.RequiredValidation1 schema class
static class	RequiredValidation.RequiredValidationMapBuilder builder for Map payloads
static class	RequiredValidation.RequiredValidationMap output class for Map payloads
sealed interface	RequiredValidation.BarBoxed sealed interface for validated payloads
record	RequiredValidation.BarBoxedVoid boxed class to store validated null payloads
record	RequiredValidation.BarBoxedBoolean boxed class to store validated boolean payloads
record	RequiredValidation.BarBoxedNumber boxed class to store validated Number payloads
record	RequiredValidation.BarBoxedString boxed class to store validated String payloads
record	RequiredValidation.BarBoxedList boxed class to store validated List payloads
record	RequiredValidation.BarBoxedMap boxed class to store validated Map payloads
static class	RequiredValidation.Bar schema class
sealed interface	RequiredValidation.FooBoxed sealed interface for validated payloads
record	RequiredValidation.FooBoxedVoid boxed class to store validated null payloads
record	RequiredValidation.FooBoxedBoolean boxed class to store validated boolean payloads
record	RequiredValidation.FooBoxedNumber boxed class to store validated Number payloads
record	RequiredValidation.FooBoxedString boxed class to store validated String payloads
record	RequiredValidation.FooBoxedList boxed class to store validated List payloads
record	RequiredValidation.FooBoxedMap boxed class to store validated Map payloads
static class	RequiredValidation.Foo schema class

RequiredValidation1Boxed

public sealed interface RequiredValidation1Boxed
permits
RequiredValidation1BoxedVoid, RequiredValidation1BoxedBoolean, RequiredValidation1BoxedNumber, RequiredValidation1BoxedString, RequiredValidation1BoxedList, RequiredValidation1BoxedMap

sealed interface that stores validated payloads using boxed classes

RequiredValidation1BoxedVoid

public record RequiredValidation1BoxedVoid
implements RequiredValidation1Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

RequiredValidation1BoxedBoolean

public record RequiredValidation1BoxedBoolean
implements RequiredValidation1Boxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

RequiredValidation1BoxedNumber

public record RequiredValidation1BoxedNumber
implements RequiredValidation1Boxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

RequiredValidation1BoxedString

public record RequiredValidation1BoxedString
implements RequiredValidation1Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

RequiredValidation1BoxedList

public record RequiredValidation1BoxedList
implements RequiredValidation1Boxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
RequiredValidation1BoxedList(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

RequiredValidation1BoxedMap

public record RequiredValidation1BoxedMap
implements RequiredValidation1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
RequiredValidation1BoxedMap(RequiredValidationMap data) Creates an instance, private visibility

Method Summary

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

RequiredValidation1

public static class RequiredValidation1
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)),     new PropertyEntry("bar", Bar.class)) )
Set	required = Set.of(     "foo" )

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)
RequiredValidationMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object>	validate(List<?> arg, SchemaConfiguration configuration)
RequiredValidation1BoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
RequiredValidation1BoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
RequiredValidation1BoxedNumber	validateAndBox(Number arg, SchemaConfiguration configuration)
RequiredValidation1BoxedBoolean	validateAndBox(boolean arg, SchemaConfiguration configuration)
RequiredValidation1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
RequiredValidation1BoxedList	validateAndBox(List<?> arg, SchemaConfiguration configuration)
RequiredValidation1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

RequiredValidationMap0Builder

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

A class that builds the Map input type

Constructor Summary

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

RequiredValidationMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
RequiredValidationMap0Builder	foo(Void value)
RequiredValidationMap0Builder	foo(boolean value)
RequiredValidationMap0Builder	foo(String value)
RequiredValidationMap0Builder	foo(int value)
RequiredValidationMap0Builder	foo(float value)
RequiredValidationMap0Builder	foo(long value)
RequiredValidationMap0Builder	foo(double value)
RequiredValidationMap0Builder	foo(List<?> value)
RequiredValidationMap0Builder	foo(Map<String, ?> value)

RequiredValidationMap

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

A class to store validated Map payloads

Method Summary

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

BarBoxed

public sealed interface BarBoxed
permits
BarBoxedVoid, BarBoxedBoolean, BarBoxedNumber, BarBoxedString, BarBoxedList, BarBoxedMap

sealed interface that stores validated payloads using boxed classes

BarBoxedVoid

public record BarBoxedVoid
implements BarBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

BarBoxedBoolean

public record BarBoxedBoolean
implements BarBoxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

BarBoxedNumber

public record BarBoxedNumber
implements BarBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

BarBoxedString

public record BarBoxedString
implements BarBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

BarBoxedList

public record BarBoxedList
implements BarBoxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
BarBoxedList(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

BarBoxedMap

public record BarBoxedMap
implements BarBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Bar

public static class Bar
extends AnyTypeJsonSchema.AnyTypeJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.AnyTypeJsonSchema.AnyTypeJsonSchema1
validate
validateAndBox

FooBoxed

public sealed interface FooBoxed
permits
FooBoxedVoid, FooBoxedBoolean, FooBoxedNumber, FooBoxedString, FooBoxedList, FooBoxedMap

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

FooBoxedBoolean

public record FooBoxedBoolean
implements FooBoxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

FooBoxedNumber

public record FooBoxedNumber
implements FooBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

FooBoxedString

public record FooBoxedString
implements FooBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

FooBoxedList

public record FooBoxedList
implements FooBoxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
FooBoxedList(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

FooBoxedMap

public record FooBoxedMap
implements FooBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Foo

public static class Foo
extends AnyTypeJsonSchema.AnyTypeJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.AnyTypeJsonSchema.AnyTypeJsonSchema1
validate
validateAndBox

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