Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Latest commit

 

History

History
179 lines (148 loc) · 7.97 KB

File metadata and controls

179 lines (148 loc) · 7.97 KB

IsoscelesTriangle

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

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 IsoscelesTriangle.IsoscelesTriangle1
schema class
static class IsoscelesTriangle.Schema1
schema class
static class IsoscelesTriangle.Schema1MapBuilder
builder for Map payloads
static class IsoscelesTriangle.Schema1Map
output class for Map payloads
static class IsoscelesTriangle.TriangleType
schema class
enum IsoscelesTriangle.StringTriangleTypeEnums
String enum

IsoscelesTriangle1

public static class IsoscelesTriangle1
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type Field and Description
List<Class<? extends JsonSchema>> allOf = List.of(
    TriangleInterface.TriangleInterface1.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)
boolean validate(boolean arg, SchemaConfiguration configuration)
FrozenMap<String, @Nullable Object> validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object> validate(List<?> arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

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

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

// Map validation
IsoscelesTriangle.Schema1Map validatedPayload =
    IsoscelesTriangle.Schema1.validate(
    new IsoscelesTriangle.Schema1MapBuilder()
        .triangleType("IsoscelesTriangle")

    .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("triangleType", TriangleType.class))
)

Method Summary

Modifier and Type Method and Description
Schema1Map validate(Map<?, ?> 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 triangleType(String value)
Schema1MapBuilder triangleType(StringTriangleTypeEnums 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 triangleType()
[optional] must be one of ["IsoscelesTriangle"]
@Nullable Object getAdditionalProperty(String name)
provides type safety for additional properties

TriangleType

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

Field Summary

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

Method Summary

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

StringTriangleTypeEnums

public enum StringTriangleTypeEnums
extends Enum<StringTriangleTypeEnums>

A class that stores String enum values

Enum Constant Summary

Enum Constant Description
ISOSCELES_TRIANGLE value = "IsoscelesTriangle"

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