Animal.md

Animal

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

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	Animal.Animal1 schema class
static class	Animal.AnimalMapBuilder builder for Map payloads
static class	Animal.AnimalMap output class for Map payloads
static class	Animal.Color schema class
static class	Animal.ClassName schema class

Animal1

public static class Animal1
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
Animal.AnimalMap validatedPayload =
    Animal.Animal1.validate(
    new Animal.AnimalMapBuilder()
        .className("a")

        .color("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("className", ClassName.class)),     new PropertyEntry("color", Color.class)) )
Set	required = Set.of(     "className" )

Method Summary

Modifier and Type	Method and Description
AnimalMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

AnimalMap0Builder

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

A class that builds the Map input type

Constructor Summary

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

AnimalMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
AnimalMap0Builder	className(String value)

AnimalMap

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

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static AnimalMap	of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
String	className()
String	color() [optional] if omitted the server will use the default value of red
@Nullable Object	getAdditionalProperty(String name) provides type safety for additional properties

Color

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

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(     String.class )
@Nullable Object	defaultValue = "red"

Method Summary

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

ClassName

public static class ClassName
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]