ArrayOfArrayOfNumberOnly.md

ArrayOfArrayOfNumberOnly

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

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	ArrayOfArrayOfNumberOnly.ArrayOfArrayOfNumberOnly1Boxed sealed interface for validated payloads
record	ArrayOfArrayOfNumberOnly.ArrayOfArrayOfNumberOnly1BoxedMap boxed class to store validated Map payloads
static class	ArrayOfArrayOfNumberOnly.ArrayOfArrayOfNumberOnly1 schema class
static class	ArrayOfArrayOfNumberOnly.ArrayOfArrayOfNumberOnlyMapBuilder builder for Map payloads
static class	ArrayOfArrayOfNumberOnly.ArrayOfArrayOfNumberOnlyMap output class for Map payloads
sealed interface	ArrayOfArrayOfNumberOnly.ArrayArrayNumberBoxed sealed interface for validated payloads
record	ArrayOfArrayOfNumberOnly.ArrayArrayNumberBoxedList boxed class to store validated List payloads
static class	ArrayOfArrayOfNumberOnly.ArrayArrayNumber schema class
static class	ArrayOfArrayOfNumberOnly.ArrayArrayNumberListBuilder builder for List payloads
static class	ArrayOfArrayOfNumberOnly.ArrayArrayNumberList output class for List payloads
sealed interface	ArrayOfArrayOfNumberOnly.ItemsBoxed sealed interface for validated payloads
record	ArrayOfArrayOfNumberOnly.ItemsBoxedList boxed class to store validated List payloads
static class	ArrayOfArrayOfNumberOnly.Items schema class
static class	ArrayOfArrayOfNumberOnly.ItemsListBuilder builder for List payloads
static class	ArrayOfArrayOfNumberOnly.ItemsList output class for List payloads
sealed interface	ArrayOfArrayOfNumberOnly.Items1Boxed sealed interface for validated payloads
record	ArrayOfArrayOfNumberOnly.Items1BoxedNumber boxed class to store validated Number payloads
static class	ArrayOfArrayOfNumberOnly.Items1 schema class

ArrayOfArrayOfNumberOnly1Boxed

public sealed interface ArrayOfArrayOfNumberOnly1Boxed
permits
ArrayOfArrayOfNumberOnly1BoxedMap

sealed interface that stores validated payloads using boxed classes

ArrayOfArrayOfNumberOnly1BoxedMap

public record ArrayOfArrayOfNumberOnly1BoxedMap
implements ArrayOfArrayOfNumberOnly1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ArrayOfArrayOfNumberOnly1BoxedMap(ArrayOfArrayOfNumberOnlyMap data) Creates an instance, private visibility

Method Summary

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

ArrayOfArrayOfNumberOnly1

public static class ArrayOfArrayOfNumberOnly1
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.ArrayOfArrayOfNumberOnly;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());

// Map validation
ArrayOfArrayOfNumberOnly.ArrayOfArrayOfNumberOnlyMap validatedPayload =
    ArrayOfArrayOfNumberOnly.ArrayOfArrayOfNumberOnly1.validate(
    new ArrayOfArrayOfNumberOnly.ArrayOfArrayOfNumberOnlyMapBuilder()
        .ArrayArrayNumber(
            Arrays.asList(
                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("ArrayArrayNumber", ArrayArrayNumber.class)) )

Method Summary

Modifier and Type	Method and Description
ArrayOfArrayOfNumberOnlyMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
ArrayOfArrayOfNumberOnly1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
ArrayOfArrayOfNumberOnly1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ArrayOfArrayOfNumberOnlyMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

ArrayOfArrayOfNumberOnlyMap

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

A class to store validated Map payloads

Method Summary

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

ArrayArrayNumberBoxed

public sealed interface ArrayArrayNumberBoxed
permits
ArrayArrayNumberBoxedList

sealed interface that stores validated payloads using boxed classes

ArrayArrayNumberBoxedList

public record ArrayArrayNumberBoxedList
implements ArrayArrayNumberBoxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ArrayArrayNumberBoxedList(ArrayArrayNumberList data) Creates an instance, private visibility

Method Summary

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

ArrayArrayNumber

public static class ArrayArrayNumber
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.ArrayOfArrayOfNumberOnly;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());

// List validation
ArrayOfArrayOfNumberOnly.ArrayArrayNumberList validatedPayload =
    ArrayOfArrayOfNumberOnly.ArrayArrayNumber.validate(
    new ArrayOfArrayOfNumberOnly.ArrayArrayNumberListBuilder()
        .add(
            Arrays.asList(
                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
ArrayArrayNumberList	validate(List<?> arg, SchemaConfiguration configuration)
ArrayArrayNumberBoxedList	validateAndBox(List<?> arg, SchemaConfiguration configuration)
ArrayArrayNumberBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ArrayArrayNumberListBuilder

public class ArrayArrayNumberListBuilder
builder for List<List<Number>>

A class that builds the List input type

Constructor Summary

Constructor and Description
ArrayArrayNumberListBuilder() Creates an empty list
ArrayArrayNumberListBuilder(List<List> items) Stores the items in a list

Method Summary

Modifier and Type	Method and Description
ArrayArrayNumberListBuilder	add(List item)
List<List>	build() Returns list input that should be used with Schema.validate

ArrayArrayNumberList

public class ArrayArrayNumberList
extends FrozenList<ItemsList>

A class to store validated List payloads

Method Summary

Modifier and Type	Method and Description
static ArrayArrayNumberList	of(List<List> arg, SchemaConfiguration configuration)

ItemsBoxed

public sealed interface ItemsBoxed
permits
ItemsBoxedList

sealed interface that stores validated payloads using boxed classes

ItemsBoxedList

public record ItemsBoxedList
implements ItemsBoxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ItemsBoxedList(ItemsList data) Creates an instance, private visibility

Method Summary

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

Items

public static class Items
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.ArrayOfArrayOfNumberOnly;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());

// List validation
ArrayOfArrayOfNumberOnly.ItemsList validatedPayload =
    ArrayOfArrayOfNumberOnly.Items.validate(
    new ArrayOfArrayOfNumberOnly.ItemsListBuilder()
        .add(1)

    .build(),
    configuration
);

Field Summary

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

Method Summary

Modifier and Type	Method and Description
ItemsList	validate(List<?> arg, SchemaConfiguration configuration)
ItemsBoxedList	validateAndBox(List<?> arg, SchemaConfiguration configuration)
ItemsBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ItemsListBuilder

public class ItemsListBuilder
builder for List<Number>

A class that builds the List input type

Constructor Summary

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

Method Summary

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

ItemsList

public class ItemsList
extends FrozenList<Number>

A class to store validated List payloads

Method Summary

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

Items1Boxed

public sealed interface Items1Boxed
permits
Items1BoxedNumber

sealed interface that stores validated payloads using boxed classes

Items1BoxedNumber

public record Items1BoxedNumber
implements Items1Boxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Items1

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