TriangleInterface.md

TriangleInterface

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

A class that contains necessary nested schema classes, and classes to store validated list and map payloads

Nested Class Summary

Modifier and Type	Class and Description
static class	TriangleInterface.TriangleInterface1 schema class
static class	TriangleInterface.TriangleInterfaceMap output class for Map payloads
static class	TriangleInterface.TriangleType schema class
static class	TriangleInterface.ShapeType schema class

TriangleInterface1

public static class TriangleInterface1
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries(     new KeywordEntry("properties", new PropertiesValidator(Map.ofEntries(         new PropertyEntry("shapeType", ShapeType.class)),         new PropertyEntry("triangleType", TriangleType.class))     ))),     new KeywordEntry("required", new RequiredValidator(Set.of(         "shapeType",         "triangleType"     ))) ));

Method Summary

Modifier and Type	Method and Description
static String	validate(String arg, SchemaConfiguration configuration)
static Void	validate(Void arg, SchemaConfiguration configuration)
static int	validate(int arg, SchemaConfiguration configuration)
static long	validate(long arg, SchemaConfiguration configuration)
static float	validate(float arg, SchemaConfiguration configuration)
static double	validate(double arg, SchemaConfiguration configuration)
static boolean	validate(boolean arg, SchemaConfiguration configuration)
static TriangleInterfaceMap	validate(Map<String, Object> arg, SchemaConfiguration configuration)
FrozenList	validate(List arg, SchemaConfiguration configuration)

TriangleInterfaceMap

public static class TriangleInterfaceMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static TriangleInterfaceMap	of(Map<String, Object> arg, SchemaConfiguration configuration)
String	shapeType() must be one of ["Triangle"]
String	triangleType()
Object	getAdditionalProperty(String name) provides type safety for additional properties

Input Map Keys

type: Map<String, Object>

Key	Type	Description	Notes
shapeType	String		must be one of ["Triangle"]
triangleType	String
anyStringName	Object	any string name can be used but the value must be the correct type	[optional]

TriangleType

public static class TriangleType
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.MapMaker;
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 = TriangleInterface.ShapeType.validate(
    "Triangle",
    configuration
);

Field Summary

Modifier and Type	Field and Description
static LinkedHashMap<String, KeywordValidator>	keywordToValidator new LinkedHashMap<>(Map.ofEntries(     new KeywordEntry("type", new TypeValidator(Set.of(         String.class     ))),     new KeywordEntry("enum", new EnumValidator(Set.of(         "Triangle" ))) ));

Method Summary

Modifier and Type	Method and Description
static String	validate(String arg, SchemaConfiguration configuration)

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