Fruit.md

Fruit

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

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	Fruit.Fruit1Boxed sealed interface for validated payloads
record	Fruit.Fruit1BoxedVoid boxed class to store validated null payloads
record	Fruit.Fruit1BoxedBoolean boxed class to store validated boolean payloads
record	Fruit.Fruit1BoxedNumber boxed class to store validated Number payloads
record	Fruit.Fruit1BoxedString boxed class to store validated String payloads
record	Fruit.Fruit1BoxedList boxed class to store validated List payloads
record	Fruit.Fruit1BoxedMap boxed class to store validated Map payloads
static class	Fruit.Fruit1 schema class
static class	Fruit.FruitMapBuilder builder for Map payloads
static class	Fruit.FruitMap output class for Map payloads
sealed interface	Fruit.ColorBoxed sealed interface for validated payloads
record	Fruit.ColorBoxedString boxed class to store validated String payloads
static class	Fruit.Color schema class

Fruit1Boxed

public sealed interface Fruit1Boxed
permits
Fruit1BoxedVoid, Fruit1BoxedBoolean, Fruit1BoxedNumber, Fruit1BoxedString, Fruit1BoxedList, Fruit1BoxedMap

sealed interface that stores validated payloads using boxed classes

Fruit1BoxedVoid

public record Fruit1BoxedVoid
implements Fruit1Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Fruit1BoxedBoolean

public record Fruit1BoxedBoolean
implements Fruit1Boxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Fruit1BoxedNumber

public record Fruit1BoxedNumber
implements Fruit1Boxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Fruit1BoxedString

public record Fruit1BoxedString
implements Fruit1Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Fruit1BoxedList

public record Fruit1BoxedList
implements Fruit1Boxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

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

Fruit1BoxedMap

public record Fruit1BoxedMap
implements Fruit1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
Fruit1BoxedMap(FruitMap data) Creates an instance, private visibility

Method Summary

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

Fruit1

public static class Fruit1
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("color", Color.class)) )
List<Class<? extends JsonSchema>>	oneOf = List.of(     Apple.Apple1.class,     Banana.Banana1.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)
FruitMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object>	validate(List<?> arg, SchemaConfiguration configuration)
Fruit1BoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
Fruit1BoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
Fruit1BoxedNumber	validateAndBox(Number arg, SchemaConfiguration configuration)
Fruit1BoxedBoolean	validateAndBox(boolean arg, SchemaConfiguration configuration)
Fruit1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
Fruit1BoxedList	validateAndBox(List<?> arg, SchemaConfiguration configuration)
Fruit1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

FruitMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

FruitMap

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

A class to store validated Map payloads

Method Summary

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

ColorBoxed

public sealed interface ColorBoxed
permits
ColorBoxedString

sealed interface that stores validated payloads using boxed classes

ColorBoxedString

public record ColorBoxedString
implements ColorBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Color

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