org.openapijsonschematools.client.components.schemas.AdditionalPropertiesClass.java
public class AdditionalPropertiesClass
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 map payloads, extends FrozenMap
- classes to build inputs for map payloads
public sealed interface AdditionalPropertiesClass1Boxed
permits
AdditionalPropertiesClass1BoxedMap
sealed interface that stores validated payloads using boxed classes
public record AdditionalPropertiesClass1BoxedMap
implements AdditionalPropertiesClass1Boxed
record that stores validated Map payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalPropertiesClass1BoxedMap(AdditionalPropertiesClassMap data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
AdditionalPropertiesClassMap | data() validated payload |
@Nullable Object | getData() validated payload |
public static class AdditionalPropertiesClass1
extends JsonSchema
A schema class that validates payloads
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.AdditionalPropertiesClass;
import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;
static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());
// Map validation
AdditionalPropertiesClass.AdditionalPropertiesClassMap validatedPayload =
AdditionalPropertiesClass.AdditionalPropertiesClass1.validate(
new AdditionalPropertiesClass.AdditionalPropertiesClassMapBuilder()
.map_property(
MapUtils.makeMap(
new AbstractMap.SimpleEntry<String, String>(
"someAdditionalProperty",
"a"
)
)
)
.map_of_map_property(
MapUtils.makeMap(
new AbstractMap.SimpleEntry<String, Map<String, ?>>(
"someAdditionalProperty",
MapUtils.makeMap(
new AbstractMap.SimpleEntry<String, String>(
"someAdditionalProperty",
"a"
)
)
)
)
)
.map_with_undeclared_properties_anytype_3(
MapUtils.makeMap(
)
)
.empty_map(
MapUtils.makeMap(
)
)
.map_with_undeclared_properties_string(
MapUtils.makeMap(
new AbstractMap.SimpleEntry<String, String>(
"someAdditionalProperty",
"a"
)
)
)
.build(),
configuration
);
Modifier and Type | Field and Description |
---|---|
Set<Class<?>> | type = Set.of(Map.class) |
Map<String, Class<? extends JsonSchema>> | properties = 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)) ) |
Modifier and Type | Method and Description |
---|---|
AdditionalPropertiesClassMap | validate(Map<?, ?> arg, SchemaConfiguration configuration) |
AdditionalPropertiesClass1BoxedMap | validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration) |
AdditionalPropertiesClass1Boxed | validateAndBox(@Nullable Object arg, SchemaConfiguration configuration) |
@Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
public class AdditionalPropertiesClassMapBuilder
builder for Map<String, @Nullable Object>
A class that builds the Map input type
Constructor and Description |
---|
AdditionalPropertiesClassMapBuilder() Creates a builder that contains an empty map |
Modifier and Type | Method and Description |
---|---|
Map<String, @Nullable Object> | build() Returns map input that should be used with Schema.validate |
AdditionalPropertiesClassMapBuilder | map_property(Map<String, String> value) |
AdditionalPropertiesClassMapBuilder | map_of_map_property(Map<String, Map<String, String>> value) |
AdditionalPropertiesClassMapBuilder | anytype_1(Void value) |
AdditionalPropertiesClassMapBuilder | anytype_1(boolean value) |
AdditionalPropertiesClassMapBuilder | anytype_1(String value) |
AdditionalPropertiesClassMapBuilder | anytype_1(int value) |
AdditionalPropertiesClassMapBuilder | anytype_1(float value) |
AdditionalPropertiesClassMapBuilder | anytype_1(long value) |
AdditionalPropertiesClassMapBuilder | anytype_1(double value) |
AdditionalPropertiesClassMapBuilder | anytype_1(List<?> value) |
AdditionalPropertiesClassMapBuilder | anytype_1(Map<String, ?> value) |
AdditionalPropertiesClassMapBuilder | map_with_undeclared_properties_anytype_1(Map<String, @Nullable Object> value) |
AdditionalPropertiesClassMapBuilder | map_with_undeclared_properties_anytype_2(Map<String, @Nullable Object> value) |
AdditionalPropertiesClassMapBuilder | map_with_undeclared_properties_anytype_3(Map<String, @Nullable Object> value) |
AdditionalPropertiesClassMapBuilder | empty_map(Map<String, @Nullable Object> value) |
AdditionalPropertiesClassMapBuilder | map_with_undeclared_properties_string(Map<String, String> value) |
AdditionalPropertiesClassMapBuilder | additionalProperty(String key, Void value) |
AdditionalPropertiesClassMapBuilder | additionalProperty(String key, boolean value) |
AdditionalPropertiesClassMapBuilder | additionalProperty(String key, String value) |
AdditionalPropertiesClassMapBuilder | additionalProperty(String key, int value) |
AdditionalPropertiesClassMapBuilder | additionalProperty(String key, float value) |
AdditionalPropertiesClassMapBuilder | additionalProperty(String key, long value) |
AdditionalPropertiesClassMapBuilder | additionalProperty(String key, double value) |
AdditionalPropertiesClassMapBuilder | additionalProperty(String key, List<?> value) |
AdditionalPropertiesClassMapBuilder | additionalProperty(String key, Map<String, ?> value) |
public static class AdditionalPropertiesClassMap
extends FrozenMap<String, @Nullable Object>
A class to store validated Map payloads
Modifier and Type | Method and Description |
---|---|
static AdditionalPropertiesClassMap | of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration) |
MapPropertyMap | map_property() [optional] |
MapOfMapPropertyMap | map_of_map_property() [optional] |
@Nullable Object | anytype_1() [optional] |
FrozenMap<?> | map_with_undeclared_properties_anytype_1() [optional] |
FrozenMap<?> | 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] |
@Nullable Object | getAdditionalProperty(String name) provides type safety for additional properties |
public sealed interface MapWithUndeclaredPropertiesStringBoxed
permits
MapWithUndeclaredPropertiesStringBoxedMap
sealed interface that stores validated payloads using boxed classes
public record MapWithUndeclaredPropertiesStringBoxedMap
implements MapWithUndeclaredPropertiesStringBoxed
record that stores validated Map payloads, sealed permits implementation
Constructor and Description |
---|
MapWithUndeclaredPropertiesStringBoxedMap(MapWithUndeclaredPropertiesStringMap data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
MapWithUndeclaredPropertiesStringMap | data() validated payload |
@Nullable Object | getData() validated payload |
public static class MapWithUndeclaredPropertiesString
extends JsonSchema
A schema class that validates payloads
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.AdditionalPropertiesClass;
import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;
static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());
// Map validation
AdditionalPropertiesClass.MapWithUndeclaredPropertiesStringMap validatedPayload =
AdditionalPropertiesClass.MapWithUndeclaredPropertiesString.validate(
new AdditionalPropertiesClass.MapWithUndeclaredPropertiesStringMapBuilder()
.additionalProperty("someAdditionalProperty", "a")
.build(),
configuration
);
Modifier and Type | Field and Description |
---|---|
Set<Class<?>> | type = Set.of(Map.class) |
Class<? extends JsonSchema> | additionalProperties = AdditionalProperties5.class |
Modifier and Type | Method and Description |
---|---|
MapWithUndeclaredPropertiesStringMap | validate(Map<?, ?> arg, SchemaConfiguration configuration) |
MapWithUndeclaredPropertiesStringBoxedMap | validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration) |
MapWithUndeclaredPropertiesStringBoxed | validateAndBox(@Nullable Object arg, SchemaConfiguration configuration) |
@Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
public class MapWithUndeclaredPropertiesStringMapBuilder
builder for Map<String, String>
A class that builds the Map input type
Constructor and Description |
---|
MapWithUndeclaredPropertiesStringMapBuilder() Creates a builder that contains an empty map |
Modifier and Type | Method and Description |
---|---|
Map<String, String> | build() Returns map input that should be used with Schema.validate |
MapWithUndeclaredPropertiesStringMapBuilder | additionalProperty(String key, String value) |
public static class MapWithUndeclaredPropertiesStringMap
extends FrozenMap<String, String>
A class to store validated Map payloads
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 |
public sealed interface AdditionalProperties5Boxed
permits
AdditionalProperties5BoxedString
sealed interface that stores validated payloads using boxed classes
public record AdditionalProperties5BoxedString
implements AdditionalProperties5Boxed
record that stores validated String payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalProperties5BoxedString(String data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
String | data() validated payload |
@Nullable Object | getData() validated payload |
public static class AdditionalProperties5
extends StringJsonSchema.StringJsonSchema1
A schema class that validates payloads
Methods Inherited from class org.openapijsonschematools.client.schemas.StringJsonSchema.StringJsonSchema1 |
---|
validate |
validateAndBox |
public sealed interface EmptyMapBoxed
permits
EmptyMapBoxedMap
sealed interface that stores validated payloads using boxed classes
public record EmptyMapBoxedMap
implements EmptyMapBoxed
record that stores validated Map payloads, sealed permits implementation
Constructor and Description |
---|
EmptyMapBoxedMap(EmptyMapMap data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
EmptyMapMap | data() validated payload |
@Nullable Object | getData() validated payload |
public static class EmptyMap
extends JsonSchema
A schema class that validates payloads
an object with no declared properties and no undeclared properties, hence it's an empty map.
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.AdditionalPropertiesClass;
import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;
static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());
// Map validation
AdditionalPropertiesClass.EmptyMapMap validatedPayload =
AdditionalPropertiesClass.EmptyMap.validate(
new AdditionalPropertiesClass.EmptyMapMapBuilder()
.build(),
configuration
);
Modifier and Type | Field and Description |
---|---|
Set<Class<?>> | type = Set.of(Map.class) |
Class<? extends JsonSchema> | additionalProperties = AdditionalProperties4.class |
Modifier and Type | Method and Description |
---|---|
EmptyMapMap | validate(Map<?, ?> arg, SchemaConfiguration configuration) |
EmptyMapBoxedMap | validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration) |
EmptyMapBoxed | validateAndBox(@Nullable Object arg, SchemaConfiguration configuration) |
@Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
public class EmptyMapMapBuilder
builder for Map<String, @Nullable Object>
A class that builds the Map input type
Constructor and Description |
---|
EmptyMapMapBuilder() Creates a builder that contains an empty map |
Modifier and Type | Method and Description |
---|---|
Map<String, @Nullable Object> | build() Returns map input that should be used with Schema.validate |
public static class EmptyMapMap
extends FrozenMap<String, Object>
A class to store validated Map payloads
Modifier and Type | Method and Description |
---|---|
static EmptyMapMap | of(Map<String, Object> arg, SchemaConfiguration configuration) |
public sealed interface AdditionalProperties4Boxed
permits
AdditionalProperties4BoxedVoid,
AdditionalProperties4BoxedBoolean,
AdditionalProperties4BoxedNumber,
AdditionalProperties4BoxedString,
AdditionalProperties4BoxedList,
AdditionalProperties4BoxedMap
sealed interface that stores validated payloads using boxed classes
public record AdditionalProperties4BoxedVoid
implements AdditionalProperties4Boxed
record that stores validated null payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalProperties4BoxedVoid(Void data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
Void | data() validated payload |
@Nullable Object | getData() validated payload |
public record AdditionalProperties4BoxedBoolean
implements AdditionalProperties4Boxed
record that stores validated boolean payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalProperties4BoxedBoolean(boolean data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
boolean | data() validated payload |
@Nullable Object | getData() validated payload |
public record AdditionalProperties4BoxedNumber
implements AdditionalProperties4Boxed
record that stores validated Number payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalProperties4BoxedNumber(Number data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
Number | data() validated payload |
@Nullable Object | getData() validated payload |
public record AdditionalProperties4BoxedString
implements AdditionalProperties4Boxed
record that stores validated String payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalProperties4BoxedString(String data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
String | data() validated payload |
@Nullable Object | getData() validated payload |
public record AdditionalProperties4BoxedList
implements AdditionalProperties4Boxed
record that stores validated List payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalProperties4BoxedList(FrozenList<@Nullable Object> data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
FrozenList<@Nullable Object> | data() validated payload |
@Nullable Object | getData() validated payload |
public record AdditionalProperties4BoxedMap
implements AdditionalProperties4Boxed
record that stores validated Map payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalProperties4BoxedMap(FrozenMap<@Nullable Object> data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
FrozenMap<@Nullable Object> | data() validated payload |
@Nullable Object | getData() validated payload |
public static class AdditionalProperties4
extends NotAnyTypeJsonSchema.NotAnyTypeJsonSchema1
A schema class that validates payloads
Methods Inherited from class org.openapijsonschematools.client.schemas.NotAnyTypeJsonSchema.NotAnyTypeJsonSchema1 |
---|
validate |
validateAndBox |
public sealed interface MapWithUndeclaredPropertiesAnytype3Boxed
permits
MapWithUndeclaredPropertiesAnytype3BoxedMap
sealed interface that stores validated payloads using boxed classes
public record MapWithUndeclaredPropertiesAnytype3BoxedMap
implements MapWithUndeclaredPropertiesAnytype3Boxed
record that stores validated Map payloads, sealed permits implementation
Constructor and Description |
---|
MapWithUndeclaredPropertiesAnytype3BoxedMap(MapWithUndeclaredPropertiesAnytype3Map data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
MapWithUndeclaredPropertiesAnytype3Map | data() validated payload |
@Nullable Object | getData() validated payload |
public static class MapWithUndeclaredPropertiesAnytype3
extends JsonSchema
A schema class that validates payloads
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.AdditionalPropertiesClass;
import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;
static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());
// Map validation
AdditionalPropertiesClass.MapWithUndeclaredPropertiesAnytype3Map validatedPayload =
AdditionalPropertiesClass.MapWithUndeclaredPropertiesAnytype3.validate(
new AdditionalPropertiesClass.MapWithUndeclaredPropertiesAnytype3MapBuilder()
.build(),
configuration
);
Modifier and Type | Field and Description |
---|---|
Set<Class<?>> | type = Set.of(Map.class) |
Class<? extends JsonSchema> | additionalProperties = AdditionalProperties3.class |
Modifier and Type | Method and Description |
---|---|
MapWithUndeclaredPropertiesAnytype3Map | validate(Map<?, ?> arg, SchemaConfiguration configuration) |
MapWithUndeclaredPropertiesAnytype3BoxedMap | validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration) |
MapWithUndeclaredPropertiesAnytype3Boxed | validateAndBox(@Nullable Object arg, SchemaConfiguration configuration) |
@Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
public class MapWithUndeclaredPropertiesAnytype3MapBuilder
builder for Map<String, @Nullable Object>
A class that builds the Map input type
Constructor and Description |
---|
MapWithUndeclaredPropertiesAnytype3MapBuilder() Creates a builder that contains an empty map |
Modifier and Type | Method and Description |
---|---|
Map<String, @Nullable Object> | build() Returns map input that should be used with Schema.validate |
MapWithUndeclaredPropertiesAnytype3MapBuilder | additionalProperty(String key, Void value) |
MapWithUndeclaredPropertiesAnytype3MapBuilder | additionalProperty(String key, boolean value) |
MapWithUndeclaredPropertiesAnytype3MapBuilder | additionalProperty(String key, String value) |
MapWithUndeclaredPropertiesAnytype3MapBuilder | additionalProperty(String key, int value) |
MapWithUndeclaredPropertiesAnytype3MapBuilder | additionalProperty(String key, float value) |
MapWithUndeclaredPropertiesAnytype3MapBuilder | additionalProperty(String key, long value) |
MapWithUndeclaredPropertiesAnytype3MapBuilder | additionalProperty(String key, double value) |
MapWithUndeclaredPropertiesAnytype3MapBuilder | additionalProperty(String key, List<?> value) |
MapWithUndeclaredPropertiesAnytype3MapBuilder | additionalProperty(String key, Map<String, ?> value) |
public static class MapWithUndeclaredPropertiesAnytype3Map
extends FrozenMap<String, @Nullable Object>
A class to store validated Map payloads
Modifier and Type | Method and Description |
---|---|
static MapWithUndeclaredPropertiesAnytype3Map | of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration) |
@Nullable Object | getAdditionalProperty(String name) provides type safety for additional properties |
public sealed interface AdditionalProperties3Boxed
permits
AdditionalProperties3BoxedVoid,
AdditionalProperties3BoxedBoolean,
AdditionalProperties3BoxedNumber,
AdditionalProperties3BoxedString,
AdditionalProperties3BoxedList,
AdditionalProperties3BoxedMap
sealed interface that stores validated payloads using boxed classes
public record AdditionalProperties3BoxedVoid
implements AdditionalProperties3Boxed
record that stores validated null payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalProperties3BoxedVoid(Void data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
Void | data() validated payload |
@Nullable Object | getData() validated payload |
public record AdditionalProperties3BoxedBoolean
implements AdditionalProperties3Boxed
record that stores validated boolean payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalProperties3BoxedBoolean(boolean data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
boolean | data() validated payload |
@Nullable Object | getData() validated payload |
public record AdditionalProperties3BoxedNumber
implements AdditionalProperties3Boxed
record that stores validated Number payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalProperties3BoxedNumber(Number data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
Number | data() validated payload |
@Nullable Object | getData() validated payload |
public record AdditionalProperties3BoxedString
implements AdditionalProperties3Boxed
record that stores validated String payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalProperties3BoxedString(String data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
String | data() validated payload |
@Nullable Object | getData() validated payload |
public record AdditionalProperties3BoxedList
implements AdditionalProperties3Boxed
record that stores validated List payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalProperties3BoxedList(FrozenList<@Nullable Object> data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
FrozenList<@Nullable Object> | data() validated payload |
@Nullable Object | getData() validated payload |
public record AdditionalProperties3BoxedMap
implements AdditionalProperties3Boxed
record that stores validated Map payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalProperties3BoxedMap(FrozenMap<@Nullable Object> data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
FrozenMap<@Nullable Object> | data() validated payload |
@Nullable Object | getData() validated payload |
public static class AdditionalProperties3
extends AnyTypeJsonSchema.AnyTypeJsonSchema1
A schema class that validates payloads
Methods Inherited from class org.openapijsonschematools.client.schemas.AnyTypeJsonSchema.AnyTypeJsonSchema1 |
---|
validate |
validateAndBox |
public sealed interface MapWithUndeclaredPropertiesAnytype2Boxed
permits
MapWithUndeclaredPropertiesAnytype2BoxedMap
sealed interface that stores validated payloads using boxed classes
public record MapWithUndeclaredPropertiesAnytype2BoxedMap
implements MapWithUndeclaredPropertiesAnytype2Boxed
record that stores validated Map payloads, sealed permits implementation
Constructor and Description |
---|
MapWithUndeclaredPropertiesAnytype2BoxedMap(FrozenMap<@Nullable Object> data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
FrozenMap<@Nullable Object> | data() validated payload |
@Nullable Object | getData() validated payload |
public static class MapWithUndeclaredPropertiesAnytype2
extends MapJsonSchema.MapJsonSchema1
A schema class that validates payloads
Methods Inherited from class org.openapijsonschematools.client.schemas.MapJsonSchema.MapJsonSchema1 |
---|
validate |
validateAndBox |
public sealed interface MapWithUndeclaredPropertiesAnytype1Boxed
permits
MapWithUndeclaredPropertiesAnytype1BoxedMap
sealed interface that stores validated payloads using boxed classes
public record MapWithUndeclaredPropertiesAnytype1BoxedMap
implements MapWithUndeclaredPropertiesAnytype1Boxed
record that stores validated Map payloads, sealed permits implementation
Constructor and Description |
---|
MapWithUndeclaredPropertiesAnytype1BoxedMap(FrozenMap<@Nullable Object> data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
FrozenMap<@Nullable Object> | data() validated payload |
@Nullable Object | getData() validated payload |
public static class MapWithUndeclaredPropertiesAnytype1
extends MapJsonSchema.MapJsonSchema1
A schema class that validates payloads
Methods Inherited from class org.openapijsonschematools.client.schemas.MapJsonSchema.MapJsonSchema1 |
---|
validate |
validateAndBox |
public sealed interface Anytype1Boxed
permits
Anytype1BoxedVoid,
Anytype1BoxedBoolean,
Anytype1BoxedNumber,
Anytype1BoxedString,
Anytype1BoxedList,
Anytype1BoxedMap
sealed interface that stores validated payloads using boxed classes
public record Anytype1BoxedVoid
implements Anytype1Boxed
record that stores validated null payloads, sealed permits implementation
Constructor and Description |
---|
Anytype1BoxedVoid(Void data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
Void | data() validated payload |
@Nullable Object | getData() validated payload |
public record Anytype1BoxedBoolean
implements Anytype1Boxed
record that stores validated boolean payloads, sealed permits implementation
Constructor and Description |
---|
Anytype1BoxedBoolean(boolean data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
boolean | data() validated payload |
@Nullable Object | getData() validated payload |
public record Anytype1BoxedNumber
implements Anytype1Boxed
record that stores validated Number payloads, sealed permits implementation
Constructor and Description |
---|
Anytype1BoxedNumber(Number data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
Number | data() validated payload |
@Nullable Object | getData() validated payload |
public record Anytype1BoxedString
implements Anytype1Boxed
record that stores validated String payloads, sealed permits implementation
Constructor and Description |
---|
Anytype1BoxedString(String data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
String | data() validated payload |
@Nullable Object | getData() validated payload |
public record Anytype1BoxedList
implements Anytype1Boxed
record that stores validated List payloads, sealed permits implementation
Constructor and Description |
---|
Anytype1BoxedList(FrozenList<@Nullable Object> data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
FrozenList<@Nullable Object> | data() validated payload |
@Nullable Object | getData() validated payload |
public record Anytype1BoxedMap
implements Anytype1Boxed
record that stores validated Map payloads, sealed permits implementation
Constructor and Description |
---|
Anytype1BoxedMap(FrozenMap<@Nullable Object> data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
FrozenMap<@Nullable Object> | data() validated payload |
@Nullable Object | getData() validated payload |
public static class Anytype1
extends AnyTypeJsonSchema.AnyTypeJsonSchema1
A schema class that validates payloads
Methods Inherited from class org.openapijsonschematools.client.schemas.AnyTypeJsonSchema.AnyTypeJsonSchema1 |
---|
validate |
validateAndBox |
public sealed interface MapOfMapPropertyBoxed
permits
MapOfMapPropertyBoxedMap
sealed interface that stores validated payloads using boxed classes
public record MapOfMapPropertyBoxedMap
implements MapOfMapPropertyBoxed
record that stores validated Map payloads, sealed permits implementation
Constructor and Description |
---|
MapOfMapPropertyBoxedMap(MapOfMapPropertyMap data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
MapOfMapPropertyMap | data() validated payload |
@Nullable Object | getData() validated payload |
public static class MapOfMapProperty
extends JsonSchema
A schema class that validates payloads
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.AdditionalPropertiesClass;
import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;
static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());
// Map validation
AdditionalPropertiesClass.MapOfMapPropertyMap validatedPayload =
AdditionalPropertiesClass.MapOfMapProperty.validate(
new AdditionalPropertiesClass.MapOfMapPropertyMapBuilder()
.additionalProperty(
"someAdditionalProperty",
MapUtils.makeMap(
new AbstractMap.SimpleEntry<String, String>(
"someAdditionalProperty",
"a"
)
)
)
.build(),
configuration
);
Modifier and Type | Field and Description |
---|---|
Set<Class<?>> | type = Set.of(Map.class) |
Class<? extends JsonSchema> | additionalProperties = AdditionalProperties1.class |
Modifier and Type | Method and Description |
---|---|
MapOfMapPropertyMap | validate(Map<?, ?> arg, SchemaConfiguration configuration) |
MapOfMapPropertyBoxedMap | validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration) |
MapOfMapPropertyBoxed | validateAndBox(@Nullable Object arg, SchemaConfiguration configuration) |
@Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
public class MapOfMapPropertyMapBuilder
builder for Map<String, Map<String, String>>
A class that builds the Map input type
Constructor and Description |
---|
MapOfMapPropertyMapBuilder() Creates a builder that contains an empty map |
Modifier and Type | Method and Description |
---|---|
Map<String, Map<String, String>> | build() Returns map input that should be used with Schema.validate |
MapOfMapPropertyMapBuilder | additionalProperty(String key, Map<String, String> value) |
public static class MapOfMapPropertyMap
extends FrozenMap<String, AdditionalPropertiesMap>
A class to store validated Map payloads
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 |
public sealed interface AdditionalProperties1Boxed
permits
AdditionalProperties1BoxedMap
sealed interface that stores validated payloads using boxed classes
public record AdditionalProperties1BoxedMap
implements AdditionalProperties1Boxed
record that stores validated Map payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalProperties1BoxedMap(AdditionalPropertiesMap data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
AdditionalPropertiesMap | data() validated payload |
@Nullable Object | getData() validated payload |
public static class AdditionalProperties1
extends JsonSchema
A schema class that validates payloads
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.AdditionalPropertiesClass;
import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;
static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());
// Map validation
AdditionalPropertiesClass.AdditionalPropertiesMap validatedPayload =
AdditionalPropertiesClass.AdditionalProperties1.validate(
new AdditionalPropertiesClass.AdditionalPropertiesMapBuilder2()
.additionalProperty("someAdditionalProperty", "a")
.build(),
configuration
);
Modifier and Type | Field and Description |
---|---|
Set<Class<?>> | type = Set.of(Map.class) |
Class<? extends JsonSchema> | additionalProperties = AdditionalProperties2.class |
Modifier and Type | Method and Description |
---|---|
AdditionalPropertiesMap | validate(Map<?, ?> arg, SchemaConfiguration configuration) |
AdditionalProperties1BoxedMap | validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration) |
AdditionalProperties1Boxed | validateAndBox(@Nullable Object arg, SchemaConfiguration configuration) |
@Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
public class AdditionalPropertiesMapBuilder2
builder for Map<String, String>
A class that builds the Map input type
Constructor and Description |
---|
AdditionalPropertiesMapBuilder2() Creates a builder that contains an empty map |
Modifier and Type | Method and Description |
---|---|
Map<String, String> | build() Returns map input that should be used with Schema.validate |
AdditionalPropertiesMapBuilder2 | additionalProperty(String key, String value) |
public static class AdditionalPropertiesMap
extends FrozenMap<String, String>
A class to store validated Map payloads
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 |
public sealed interface AdditionalProperties2Boxed
permits
AdditionalProperties2BoxedString
sealed interface that stores validated payloads using boxed classes
public record AdditionalProperties2BoxedString
implements AdditionalProperties2Boxed
record that stores validated String payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalProperties2BoxedString(String data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
String | data() validated payload |
@Nullable Object | getData() validated payload |
public static class AdditionalProperties2
extends StringJsonSchema.StringJsonSchema1
A schema class that validates payloads
Methods Inherited from class org.openapijsonschematools.client.schemas.StringJsonSchema.StringJsonSchema1 |
---|
validate |
validateAndBox |
public sealed interface MapPropertyBoxed
permits
MapPropertyBoxedMap
sealed interface that stores validated payloads using boxed classes
public record MapPropertyBoxedMap
implements MapPropertyBoxed
record that stores validated Map payloads, sealed permits implementation
Constructor and Description |
---|
MapPropertyBoxedMap(MapPropertyMap data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
MapPropertyMap | data() validated payload |
@Nullable Object | getData() validated payload |
public static class MapProperty
extends JsonSchema
A schema class that validates payloads
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.AdditionalPropertiesClass;
import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;
static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());
// Map validation
AdditionalPropertiesClass.MapPropertyMap validatedPayload =
AdditionalPropertiesClass.MapProperty.validate(
new AdditionalPropertiesClass.MapPropertyMapBuilder()
.additionalProperty("someAdditionalProperty", "a")
.build(),
configuration
);
Modifier and Type | Field and Description |
---|---|
Set<Class<?>> | type = Set.of(Map.class) |
Class<? extends JsonSchema> | additionalProperties = AdditionalProperties.class |
Modifier and Type | Method and Description |
---|---|
MapPropertyMap | validate(Map<?, ?> arg, SchemaConfiguration configuration) |
MapPropertyBoxedMap | validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration) |
MapPropertyBoxed | validateAndBox(@Nullable Object arg, SchemaConfiguration configuration) |
@Nullable Object | validate(@Nullable Object arg, SchemaConfiguration configuration) |
public class MapPropertyMapBuilder
builder for Map<String, String>
A class that builds the Map input type
Constructor and Description |
---|
MapPropertyMapBuilder() Creates a builder that contains an empty map |
Modifier and Type | Method and Description |
---|---|
Map<String, String> | build() Returns map input that should be used with Schema.validate |
MapPropertyMapBuilder | additionalProperty(String key, String value) |
public static class MapPropertyMap
extends FrozenMap<String, String>
A class to store validated Map payloads
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 |
public sealed interface AdditionalPropertiesBoxed
permits
AdditionalPropertiesBoxedString
sealed interface that stores validated payloads using boxed classes
public record AdditionalPropertiesBoxedString
implements AdditionalPropertiesBoxed
record that stores validated String payloads, sealed permits implementation
Constructor and Description |
---|
AdditionalPropertiesBoxedString(String data) Creates an instance, private visibility |
Modifier and Type | Method and Description |
---|---|
String | data() validated payload |
@Nullable Object | getData() validated payload |
public static class AdditionalProperties
extends StringJsonSchema.StringJsonSchema1
A schema class that validates payloads
Methods Inherited from class org.openapijsonschematools.client.schemas.StringJsonSchema.StringJsonSchema1 |
---|
validate |
validateAndBox |