NumberOnly.md

NumberOnly

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

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	NumberOnly.NumberOnly1 schema class
static class	NumberOnly.NumberOnlyMap output class for Map payloads
static class	NumberOnly.JustNumber schema class

NumberOnly1

public static class NumberOnly1
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
NumberOnly.NumberOnlyMap validatedPayload =
    NumberOnly.NumberOnly1.validate(
    MapMaker.makeMap(
        new AbstractMap.SimpleEntry<>(
            "JustNumber",
            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("JustNumber", JustNumber.class))     ))) ));

Method Summary

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

NumberOnlyMap

public static class NumberOnlyMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

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

Input Map Keys

type: Map<String, Object>

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

JustNumber

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