QuadrilateralInterface.md

QuadrilateralInterface

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

A class that contains necessary nested

• schema classes (which validate payloads), extends JsonSchema
• 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
static class	QuadrilateralInterface.QuadrilateralInterface1 schema class
static class	QuadrilateralInterface.QuadrilateralInterfaceMapBuilder builder for Map payloads
static class	QuadrilateralInterface.QuadrilateralInterfaceMap output class for Map payloads
static class	QuadrilateralInterface.QuadrilateralType schema class
static class	QuadrilateralInterface.ShapeType schema class
enum	QuadrilateralInterface.StringShapeTypeEnums String enum

QuadrilateralInterface1

public static class QuadrilateralInterface1
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("shapeType", ShapeType.class)),     new PropertyEntry("quadrilateralType", QuadrilateralType.class)) )
Set	required = Set.of(     "quadrilateralType",     "shapeType" )

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)
boolean	validate(boolean arg, SchemaConfiguration configuration)
QuadrilateralInterfaceMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object>	validate(List<?> arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

QuadrilateralInterfaceMap00Builder

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

A class that builds the Map input type

Constructor Summary

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

QuadrilateralInterfaceMap01Builder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
QuadrilateralInterfaceMap01Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
QuadrilateralInterfaceMap00Builder	shapeType(String value)
QuadrilateralInterfaceMap00Builder	shapeType(StringShapeTypeEnums value)

QuadrilateralInterfaceMap10Builder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
QuadrilateralInterfaceMap10Builder(Map<String, @Nullable Object> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
QuadrilateralInterfaceMap00Builder	quadrilateralType(String value)

QuadrilateralInterfaceMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
QuadrilateralInterfaceMap01Builder	quadrilateralType(String value)
QuadrilateralInterfaceMap10Builder	shapeType(String value)
QuadrilateralInterfaceMap10Builder	shapeType(StringShapeTypeEnums value)

QuadrilateralInterfaceMap

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

A class to store validated Map payloads

Method Summary

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

QuadrilateralType

public static class QuadrilateralType
extends StringJsonSchema

A schema class that validates payloads

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

ShapeType

public static class ShapeType
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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// String validation
String validatedPayload = QuadrilateralInterface.ShapeType.validate(
    "Quadrilateral",
    configuration
);

Field Summary

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

Method Summary

Modifier and Type	Method and Description
String	validate(String arg, SchemaConfiguration configuration)
String	validate(StringShapeTypeEnums arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

StringShapeTypeEnums

public enum StringShapeTypeEnums
extends Enum<StringShapeTypeEnums>

A class that stores String enum values

Enum Constant Summary

Enum Constant	Description
QUADRILATERAL	value = "Quadrilateral"

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