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

AdditionalPropertiesClass.md

Latest commit

 

History

History
375 lines (298 loc) · 19.5 KB

AdditionalPropertiesClass.md

File metadata and controls

375 lines (298 loc) · 19.5 KB

AdditionalPropertiesClass

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

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 AdditionalPropertiesClass.AdditionalPropertiesClass1
schema class
static class AdditionalPropertiesClass.AdditionalPropertiesClassMap
output class for Map payloads
static class AdditionalPropertiesClass.MapWithUndeclaredPropertiesString
schema class
static class AdditionalPropertiesClass.MapWithUndeclaredPropertiesStringMap
output class for Map payloads
static class AdditionalPropertiesClass.AdditionalProperties5
schema class
static class AdditionalPropertiesClass.EmptyMap
schema class
static class AdditionalPropertiesClass.EmptyMapMap
output class for Map payloads
static class AdditionalPropertiesClass.AdditionalProperties4
schema class
static class AdditionalPropertiesClass.MapWithUndeclaredPropertiesAnytype3
schema class
static class AdditionalPropertiesClass.MapWithUndeclaredPropertiesAnytype3Map
output class for Map payloads
static class AdditionalPropertiesClass.AdditionalProperties3
schema class
static class AdditionalPropertiesClass.MapWithUndeclaredPropertiesAnytype2
schema class
static class AdditionalPropertiesClass.MapWithUndeclaredPropertiesAnytype1
schema class
static class AdditionalPropertiesClass.Anytype1
schema class
static class AdditionalPropertiesClass.MapOfMapProperty
schema class
static class AdditionalPropertiesClass.MapOfMapPropertyMap
output class for Map payloads
static class AdditionalPropertiesClass.AdditionalProperties1
schema class
static class AdditionalPropertiesClass.AdditionalPropertiesMap
output class for Map payloads
static class AdditionalPropertiesClass.AdditionalProperties2
schema class
static class AdditionalPropertiesClass.MapProperty
schema class
static class AdditionalPropertiesClass.MapPropertyMap
output class for Map payloads
static class AdditionalPropertiesClass.AdditionalProperties
schema class

AdditionalPropertiesClass1

public static class AdditionalPropertiesClass1
extends JsonSchema

A schema class that validates payloads

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("map_property", MapProperty.class)),
        new PropertyEntry("map_of_map_property", MapOfMapProperty.class)),
        new PropertyEntry("anytype_1", Anytype1.class)),
        new PropertyEntry("map_with_undeclared_properties_anytype_1", MapWithUndeclaredPropertiesAnytype1.class)),
        new PropertyEntry("map_with_undeclared_properties_anytype_2", MapWithUndeclaredPropertiesAnytype2.class)),
        new PropertyEntry("map_with_undeclared_properties_anytype_3", MapWithUndeclaredPropertiesAnytype3.class)),
        new PropertyEntry("empty_map", EmptyMap.class)),
        new PropertyEntry("map_with_undeclared_properties_string", MapWithUndeclaredPropertiesString.class))
    )))
));

Method Summary

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

AdditionalPropertiesClassMap

public static class AdditionalPropertiesClassMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static AdditionalPropertiesClassMap of(Map<String, Object> arg, SchemaConfiguration configuration)
MapPropertyMap map_property()
[optional]
MapOfMapPropertyMap map_of_map_property()
[optional]
Object anytype_1()
[optional]
FrozenMap<String, Object> map_with_undeclared_properties_anytype_1()
[optional]
FrozenMap<String, Object> map_with_undeclared_properties_anytype_2()
[optional]
MapWithUndeclaredPropertiesAnytype3Map map_with_undeclared_properties_anytype_3()
[optional]
EmptyMapMap empty_map()
[optional]
MapWithUndeclaredPropertiesStringMap map_with_undeclared_properties_string()
[optional]
Object getAdditionalProperty(String name)
provides type safety for additional properties

Input Map Keys

type: Map<String, Object>
Key Type Description Notes
map_property Map<String, String> [optional]
map_of_map_property Map<String, Map<String, String>> [optional]
anytype_1 Object [optional]
map_with_undeclared_properties_anytype_1 Map<String, Object> [optional]
map_with_undeclared_properties_anytype_2 Map<String, Object> [optional]
map_with_undeclared_properties_anytype_3 Map<String, Object> [optional]
empty_map Map<String, Object> an object with no declared properties and no undeclared properties, hence it's an empty map. [optional]
map_with_undeclared_properties_string Map<String, String> [optional]
anyStringName Object any string name can be used but the value must be the correct type [optional]

MapWithUndeclaredPropertiesString

public static class MapWithUndeclaredPropertiesString
extends JsonSchema

A schema class that validates payloads

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("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties5.class))
));

Method Summary

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

MapWithUndeclaredPropertiesStringMap

public static class MapWithUndeclaredPropertiesStringMap
extends FrozenMap<String, String>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static MapWithUndeclaredPropertiesStringMap of(Map<String, String> arg, SchemaConfiguration configuration)
String getAdditionalProperty(String name)
provides type safety for additional properties

Input Map Keys

type: Map<String, Object>
Key Type Description Notes
anyStringName String any string name can be used but the value must be the correct type [optional]

AdditionalProperties5

public static class AdditionalProperties5
extends StringJsonSchema

A schema class that validates payloads

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

EmptyMap

public static class EmptyMap
extends JsonSchema

A schema class that validates payloads

Description

an object with no declared properties and no undeclared properties, hence it's an empty map.

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("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties4.class))
));

Method Summary

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

EmptyMapMap

public static class EmptyMapMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

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

Input Map Keys

type: Map<String, Object>
Key Type Description Notes

AdditionalProperties4

public static class AdditionalProperties4
extends NotAnyTypeJsonSchema

A schema class that validates payloads

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

MapWithUndeclaredPropertiesAnytype3

public static class MapWithUndeclaredPropertiesAnytype3
extends JsonSchema

A schema class that validates payloads

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("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties3.class))
));

Method Summary

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

MapWithUndeclaredPropertiesAnytype3Map

public static class MapWithUndeclaredPropertiesAnytype3Map
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static MapWithUndeclaredPropertiesAnytype3Map of(Map<String, Object> arg, SchemaConfiguration configuration)
Object getAdditionalProperty(String name)
provides type safety for additional properties

Input Map Keys

type: Map<String, Object>
Key Type Description Notes
anyStringName Object any string name can be used but the value must be the correct type [optional]

AdditionalProperties3

public static class AdditionalProperties3
extends AnyTypeJsonSchema

A schema class that validates payloads

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

MapWithUndeclaredPropertiesAnytype2

public static class MapWithUndeclaredPropertiesAnytype2
extends MapJsonSchema

A schema class that validates payloads

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

MapWithUndeclaredPropertiesAnytype1

public static class MapWithUndeclaredPropertiesAnytype1
extends MapJsonSchema

A schema class that validates payloads

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

Anytype1

public static class Anytype1
extends AnyTypeJsonSchema

A schema class that validates payloads

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

MapOfMapProperty

public static class MapOfMapProperty
extends JsonSchema

A schema class that validates payloads

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("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties1.class))
));

Method Summary

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

MapOfMapPropertyMap

public static class MapOfMapPropertyMap
extends FrozenMap<String, AdditionalPropertiesMap>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static MapOfMapPropertyMap of(Map<String, Map<String, String>> arg, SchemaConfiguration configuration)
AdditionalPropertiesMap getAdditionalProperty(String name)
provides type safety for additional properties

Input Map Keys

type: Map<String, Object>
Key Type Description Notes
anyStringName Map<String, String> any string name can be used but the value must be the correct type [optional]

AdditionalProperties1

public static class AdditionalProperties1
extends JsonSchema

A schema class that validates payloads

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("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties2.class))
));

Method Summary

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

AdditionalPropertiesMap

public static class AdditionalPropertiesMap
extends FrozenMap<String, String>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static AdditionalPropertiesMap of(Map<String, String> arg, SchemaConfiguration configuration)
String getAdditionalProperty(String name)
provides type safety for additional properties

Input Map Keys

type: Map<String, Object>
Key Type Description Notes
anyStringName String any string name can be used but the value must be the correct type [optional]

AdditionalProperties2

public static class AdditionalProperties2
extends StringJsonSchema

A schema class that validates payloads

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

MapProperty

public static class MapProperty
extends JsonSchema

A schema class that validates payloads

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("additionalProperties", new AdditionalPropertiesValidator(AdditionalProperties.class))
));

Method Summary

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

MapPropertyMap

public static class MapPropertyMap
extends FrozenMap<String, String>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static MapPropertyMap of(Map<String, String> arg, SchemaConfiguration configuration)
String getAdditionalProperty(String name)
provides type safety for additional properties

Input Map Keys

type: Map<String, Object>
Key Type Description Notes
anyStringName String any string name can be used but the value must be the correct type [optional]

AdditionalProperties

public static class AdditionalProperties
extends StringJsonSchema

A schema class that validates payloads

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

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