Dog.md

Dog

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

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

Nested Class Summary

Modifier and Type	Class and Description
static class	Dog.Dog1 schema class
static class	Dog.Schema1 schema class
static class	Dog.Schema1MapBuilder builder for Map payloads
static class	Dog.Schema1Map output class for Map payloads
static class	Dog.Breed schema class

Dog1

public static class Dog1
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type	Field and Description
List<Class<? extends JsonSchema>>	allOf = List.of(     Animal.Animal1.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
Dog.Schema1Map validatedPayload =
    Dog.Schema1.validate(
    new Dog.Schema1MapBuilder()
        .breed("a")

    .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("breed", Breed.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	breed(String 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	breed() [optional]
@Nullable Object	getAdditionalProperty(String name) provides type safety for additional properties

Breed

public static class Breed
extends StringJsonSchema

A schema class that validates payloads

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

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