ArrayOfNumberOnly.md

ArrayOfNumberOnly

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

A class that contains necessary nested

• schema classes (which validate payloads), extends JsonSchema
• sealed interfaces which store validated payloads, java version of a sum type
• boxed classes which store validated payloads, sealed permits class implementations
• classes to store validated list payloads, extends FrozenList
• classes to build inputs for list payloads
• classes to store validated map payloads, extends FrozenMap
• classes to build inputs for map payloads

Nested Class Summary

Modifier and Type	Class and Description
sealed interface	ArrayOfNumberOnly.ArrayOfNumberOnly1Boxed sealed interface for validated payloads
record	ArrayOfNumberOnly.ArrayOfNumberOnly1BoxedMap boxed class to store validated Map payloads
static class	ArrayOfNumberOnly.ArrayOfNumberOnly1 schema class
static class	ArrayOfNumberOnly.ArrayOfNumberOnlyMapBuilder builder for Map payloads
static class	ArrayOfNumberOnly.ArrayOfNumberOnlyMap output class for Map payloads
sealed interface	ArrayOfNumberOnly.ArrayNumberBoxed sealed interface for validated payloads
record	ArrayOfNumberOnly.ArrayNumberBoxedList boxed class to store validated List payloads
static class	ArrayOfNumberOnly.ArrayNumber schema class
static class	ArrayOfNumberOnly.ArrayNumberListBuilder builder for List payloads
static class	ArrayOfNumberOnly.ArrayNumberList output class for List payloads
sealed interface	ArrayOfNumberOnly.ItemsBoxed sealed interface for validated payloads
record	ArrayOfNumberOnly.ItemsBoxedNumber boxed class to store validated Number payloads
static class	ArrayOfNumberOnly.Items schema class

ArrayOfNumberOnly1Boxed

public sealed interface ArrayOfNumberOnly1Boxed
permits
ArrayOfNumberOnly1BoxedMap

sealed interface that stores validated payloads using boxed classes

ArrayOfNumberOnly1BoxedMap

public record ArrayOfNumberOnly1BoxedMap
implements ArrayOfNumberOnly1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ArrayOfNumberOnly1BoxedMap(ArrayOfNumberOnlyMap data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
ArrayOfNumberOnlyMap	data() validated payload
@Nullable Object	getData() validated payload

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.validation.MapUtils;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;
import org.openapijsonschematools.client.components.schemas.ArrayOfNumberOnly;

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(
    new ArrayOfNumberOnly.ArrayOfNumberOnlyMapBuilder()
        .ArrayNumber(
            Arrays.asList(
                1
            )
        )
    .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("ArrayNumber", ArrayNumber.class)) )

Method Summary

Modifier and Type	Method and Description
ArrayOfNumberOnlyMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
ArrayOfNumberOnly1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
ArrayOfNumberOnly1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ArrayOfNumberOnlyMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

ArrayOfNumberOnlyMap

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

A class to store validated Map payloads

Method Summary

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

ArrayNumberBoxed

public sealed interface ArrayNumberBoxed
permits
ArrayNumberBoxedList

sealed interface that stores validated payloads using boxed classes

ArrayNumberBoxedList

public record ArrayNumberBoxedList
implements ArrayNumberBoxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ArrayNumberBoxedList(ArrayNumberList data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
ArrayNumberList	data() validated payload
@Nullable Object	getData() validated payload

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.validation.MapUtils;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;
import org.openapijsonschematools.client.components.schemas.ArrayOfNumberOnly;

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(
    new ArrayOfNumberOnly.ArrayNumberListBuilder()
        .add(1)

    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(List.class)
Class<? extends JsonSchema>	items = Items.class

Method Summary

Modifier and Type	Method and Description
ArrayNumberList	validate(List<?> arg, SchemaConfiguration configuration)
ArrayNumberBoxedList	validateAndBox(List<?> arg, SchemaConfiguration configuration)
ArrayNumberBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ArrayNumberListBuilder

public class ArrayNumberListBuilder
builder for List<Number>

A class that builds the List input type

Constructor Summary

Constructor and Description
ArrayNumberListBuilder() Creates an empty list
ArrayNumberListBuilder(List items) Stores the items in a list

Method Summary

Modifier and Type	Method and Description
ArrayNumberListBuilder	add(int item)
ArrayNumberListBuilder	add(float item)
ArrayNumberListBuilder	add(long item)
ArrayNumberListBuilder	add(double item)
List	build() Returns list input that should be used with Schema.validate

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)

ItemsBoxed

public sealed interface ItemsBoxed
permits
ItemsBoxedNumber

sealed interface that stores validated payloads using boxed classes

ItemsBoxedNumber

public record ItemsBoxedNumber
implements ItemsBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ItemsBoxedNumber(Number data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
Number	data() validated payload
@Nullable Object	getData() validated payload

Items

public static class Items
extends NumberJsonSchema.NumberJsonSchema1

A schema class that validates payloads

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

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