SimpleQuadrilateral.md

SimpleQuadrilateral

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

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
• enum classes

Nested Class Summary

Modifier and Type	Class and Description
sealed interface	SimpleQuadrilateral.SimpleQuadrilateral1Boxed sealed interface for validated payloads
record	SimpleQuadrilateral.SimpleQuadrilateral1BoxedVoid boxed class to store validated null payloads
record	SimpleQuadrilateral.SimpleQuadrilateral1BoxedBoolean boxed class to store validated boolean payloads
record	SimpleQuadrilateral.SimpleQuadrilateral1BoxedNumber boxed class to store validated Number payloads
record	SimpleQuadrilateral.SimpleQuadrilateral1BoxedString boxed class to store validated String payloads
record	SimpleQuadrilateral.SimpleQuadrilateral1BoxedList boxed class to store validated List payloads
record	SimpleQuadrilateral.SimpleQuadrilateral1BoxedMap boxed class to store validated Map payloads
static class	SimpleQuadrilateral.SimpleQuadrilateral1 schema class
sealed interface	SimpleQuadrilateral.Schema1Boxed sealed interface for validated payloads
record	SimpleQuadrilateral.Schema1BoxedMap boxed class to store validated Map payloads
static class	SimpleQuadrilateral.Schema1 schema class
static class	SimpleQuadrilateral.Schema1MapBuilder builder for Map payloads
static class	SimpleQuadrilateral.Schema1Map output class for Map payloads
sealed interface	SimpleQuadrilateral.QuadrilateralTypeBoxed sealed interface for validated payloads
record	SimpleQuadrilateral.QuadrilateralTypeBoxedString boxed class to store validated String payloads
static class	SimpleQuadrilateral.QuadrilateralType schema class
enum	SimpleQuadrilateral.StringQuadrilateralTypeEnums String enum

SimpleQuadrilateral1Boxed

public sealed interface SimpleQuadrilateral1Boxed
permits
SimpleQuadrilateral1BoxedVoid, SimpleQuadrilateral1BoxedBoolean, SimpleQuadrilateral1BoxedNumber, SimpleQuadrilateral1BoxedString, SimpleQuadrilateral1BoxedList, SimpleQuadrilateral1BoxedMap

sealed interface that stores validated payloads using boxed classes

SimpleQuadrilateral1BoxedVoid

public record SimpleQuadrilateral1BoxedVoid
implements SimpleQuadrilateral1Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

SimpleQuadrilateral1BoxedBoolean

public record SimpleQuadrilateral1BoxedBoolean
implements SimpleQuadrilateral1Boxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

SimpleQuadrilateral1BoxedNumber

public record SimpleQuadrilateral1BoxedNumber
implements SimpleQuadrilateral1Boxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

SimpleQuadrilateral1BoxedString

public record SimpleQuadrilateral1BoxedString
implements SimpleQuadrilateral1Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

SimpleQuadrilateral1BoxedList

public record SimpleQuadrilateral1BoxedList
implements SimpleQuadrilateral1Boxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

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

SimpleQuadrilateral1BoxedMap

public record SimpleQuadrilateral1BoxedMap
implements SimpleQuadrilateral1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

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

SimpleQuadrilateral1

public static class SimpleQuadrilateral1
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type	Field and Description
List<Class<? extends JsonSchema>>	allOf = List.of(     QuadrilateralInterface.QuadrilateralInterface1.class,     Schema1.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)
FrozenMap<@Nullable Object>	validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object>	validate(List<?> arg, SchemaConfiguration configuration)
SimpleQuadrilateral1BoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
SimpleQuadrilateral1BoxedVoid	validateAndBox(Void arg, SchemaConfiguration configuration)
SimpleQuadrilateral1BoxedNumber	validateAndBox(Number arg, SchemaConfiguration configuration)
SimpleQuadrilateral1BoxedBoolean	validateAndBox(boolean arg, SchemaConfiguration configuration)
SimpleQuadrilateral1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
SimpleQuadrilateral1BoxedList	validateAndBox(List<?> arg, SchemaConfiguration configuration)
SimpleQuadrilateral1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

Schema1Boxed

public sealed interface Schema1Boxed
permits
Schema1BoxedMap

sealed interface that stores validated payloads using boxed classes

Schema1BoxedMap

public record Schema1BoxedMap
implements Schema1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
Schema1BoxedMap(Schema1Map data) Creates an instance, private visibility

Method Summary

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

Schema1

public static class Schema1
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.SimpleQuadrilateral;

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

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

// Map validation
SimpleQuadrilateral.Schema1Map validatedPayload =
    SimpleQuadrilateral.Schema1.validate(
    new SimpleQuadrilateral.Schema1MapBuilder()
        .quadrilateralType("SimpleQuadrilateral")

    .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("quadrilateralType", QuadrilateralType.class)) )

Method Summary

Modifier and Type	Method and Description
Schema1Map	validate(Map<?, ?> arg, SchemaConfiguration configuration)
Schema1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
Schema1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

Schema1MapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Schema1Map

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

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static Schema1Map	of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
String	quadrilateralType() [optional] must be one of ["SimpleQuadrilateral"]
@Nullable Object	getAdditionalProperty(String name) provides type safety for additional properties

QuadrilateralTypeBoxed

public sealed interface QuadrilateralTypeBoxed
permits
QuadrilateralTypeBoxedString

sealed interface that stores validated payloads using boxed classes

QuadrilateralTypeBoxedString

public record QuadrilateralTypeBoxedString
implements QuadrilateralTypeBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

QuadrilateralType

public static class QuadrilateralType
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.SimpleQuadrilateral;

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

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

// String validation
String validatedPayload = SimpleQuadrilateral.QuadrilateralType.validate(
    "SimpleQuadrilateral",
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(     String.class )
Set	enumValues = SetMaker.makeSet(     "SimpleQuadrilateral" )

Method Summary

Modifier and Type	Method and Description
String	validate(String arg, SchemaConfiguration configuration)
String	validate(StringQuadrilateralTypeEnums arg, SchemaConfiguration configuration)
QuadrilateralTypeBoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
QuadrilateralTypeBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

StringQuadrilateralTypeEnums

public enum StringQuadrilateralTypeEnums
extends Enum<StringQuadrilateralTypeEnums>

A class that stores String enum values

Enum Constant Summary

Enum Constant	Description
SIMPLE_QUADRILATERAL	value = "SimpleQuadrilateral"

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