Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Latest commit

 

History

History
149 lines (117 loc) · 6.49 KB

File metadata and controls

149 lines (117 loc) · 6.49 KB

NoAdditionalProperties

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

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

Nested Class Summary

Modifier and Type Class and Description
static class NoAdditionalProperties.NoAdditionalProperties1
schema class
static class NoAdditionalProperties.NoAdditionalPropertiesMapBuilder
builder for Map payloads
static class NoAdditionalProperties.NoAdditionalPropertiesMap
output class for Map payloads
static class NoAdditionalProperties.PetId
schema class
static class NoAdditionalProperties.Id
schema class
static class NoAdditionalProperties.AdditionalProperties
schema class

NoAdditionalProperties1

public static class NoAdditionalProperties1
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
NoAdditionalProperties.NoAdditionalPropertiesMap validatedPayload =
    NoAdditionalProperties.NoAdditionalProperties1.validate(
    new NoAdditionalProperties.NoAdditionalPropertiesMapBuilder()
        .id(1L)

        .petId(1L)

    .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("id", Id.class)),
    new PropertyEntry("petId", PetId.class))
)
Set required = Set.of(
    "id"
)
Class<? extends JsonSchema> additionalProperties = AdditionalProperties.class

Method Summary

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

NoAdditionalPropertiesMap0Builder

public class NoAdditionalPropertiesMap0Builder
builder for Map<String, Number>

A class that builds the Map input type

Constructor Summary

Constructor and Description
NoAdditionalPropertiesMap0Builder(Map<String, Number> instance)
Creates a builder that contains the passed instance

Method Summary

Modifier and Type Method and Description
Map<String, Number> build()
Returns map input that should be used with Schema.validate
NoAdditionalPropertiesMap0Builder petId(int value)
NoAdditionalPropertiesMap0Builder petId(float value)
NoAdditionalPropertiesMap0Builder petId(long value)
NoAdditionalPropertiesMap0Builder petId(double value)

NoAdditionalPropertiesMapBuilder

public class NoAdditionalPropertiesMapBuilder
builder for Map<String, Number>

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type Method and Description
NoAdditionalPropertiesMap0Builder id(int value)
NoAdditionalPropertiesMap0Builder id(float value)
NoAdditionalPropertiesMap0Builder id(long value)
NoAdditionalPropertiesMap0Builder id(double value)

NoAdditionalPropertiesMap

public static class NoAdditionalPropertiesMap
extends FrozenMap<String, Number>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static NoAdditionalPropertiesMap of(Map<String, Number> arg, SchemaConfiguration configuration)
Number id()
value must be a 64 bit integer
Number petId()
[optional] value must be a 64 bit integer

PetId

public static class PetId
extends Int64JsonSchema

A schema class that validates payloads

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

Id

public static class Id
extends Int64JsonSchema

A schema class that validates payloads

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

AdditionalProperties

public static class AdditionalProperties
extends NotAnyTypeJsonSchema

A schema class that validates payloads

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

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