BasquePig.md

BasquePig

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

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	BasquePig.BasquePig1 schema class
static class	BasquePig.BasquePigMapBuilder builder for Map payloads
static class	BasquePig.BasquePigMap output class for Map payloads
static class	BasquePig.ClassName schema class
enum	BasquePig.StringClassNameEnums String enum

BasquePig1

public static class BasquePig1
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
BasquePig.BasquePigMap validatedPayload =
    BasquePig.BasquePig1.validate(
    new BasquePig.BasquePigMapBuilder()
        .className("BasquePig")

    .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)) )
Set	required = Set.of(     "className" )

Method Summary

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

BasquePigMap0Builder

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

A class that builds the Map input type

Constructor Summary

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

BasquePigMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
BasquePigMap0Builder	className(String value)
BasquePigMap0Builder	className(StringClassNameEnums value)

BasquePigMap

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

A class to store validated Map payloads

Method Summary

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

ClassName

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

Field Summary

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

Method Summary

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

StringClassNameEnums

public enum StringClassNameEnums
extends Enum<StringClassNameEnums>

A class that stores String enum values

Enum Constant Summary

Enum Constant	Description
BASQUE_PIG	value = "BasquePig"

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