ArrayOfNumberOnly.md

ArrayOfNumberOnly

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

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	ArrayOfNumberOnly.ArrayOfNumberOnly1 schema class
static class	ArrayOfNumberOnly.ArrayOfNumberOnlyMap output class for Map payloads
static class	ArrayOfNumberOnly.ArrayNumber schema class
static class	ArrayOfNumberOnly.ArrayNumberList output class for List payloads
static class	ArrayOfNumberOnly.Items schema class

ArrayOfNumberOnly1

public static class ArrayOfNumberOnly1
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());

// Map validation
ArrayOfNumberOnly.ArrayOfNumberOnlyMap validatedPayload =
    ArrayOfNumberOnly.ArrayOfNumberOnly1.validate(
    MapMaker.makeMap(
        new AbstractMap.SimpleEntry<>(
            "ArrayNumber",
            Arrays.asList(
                1
            )
        )
    ),
    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(FrozenMap.class))),     new KeywordEntry("properties", new PropertiesValidator(Map.ofEntries(         new PropertyEntry("ArrayNumber", ArrayNumber.class))     ))) ));

Method Summary

Modifier and Type	Method and Description
static ArrayOfNumberOnlyMap	validate(Map<String, Object> arg, SchemaConfiguration configuration)

ArrayOfNumberOnlyMap

public static class ArrayOfNumberOnlyMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static ArrayOfNumberOnlyMap	of(Map<String, Object> arg, SchemaConfiguration configuration)
ArrayNumberList	ArrayNumber() [optional]
Object	getAdditionalProperty(String name) provides type safety for additional properties

Input Map Keys

type: Map<String, Object>

Key	Type	Description	Notes
ArrayNumber	List		[optional]
anyStringName	Object	any string name can be used but the value must be the correct type	[optional]

ArrayNumber

public static class ArrayNumber
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());

// List validation
ArrayOfNumberOnly.ArrayNumberList validatedPayload =
    ArrayOfNumberOnly.ArrayNumber.validate(
    Arrays.asList(
        1
    ),
    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(FrozenList.class))),     new KeywordEntry("items", new ItemsValidator(Items.class)) ));

Method Summary

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

ArrayNumberList

public class ArrayNumberList
extends FrozenList<Number>

A class to store validated List payloads

Method Summary

Modifier and Type	Method and Description
static ArrayNumberList	of(List arg, SchemaConfiguration configuration)

Input List Items

type: List<Number>

List Item Type	Description	Notes
Number

Items

public static class Items
extends NumberJsonSchema

A schema class that validates payloads

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

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