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

Latest commit

 

History

History
259 lines (203 loc) · 12.9 KB

ObjectModelWithArgAndArgsProperties.md

File metadata and controls

259 lines (203 loc) · 12.9 KB

ObjectModelWithArgAndArgsProperties

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

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

Nested Class Summary

Modifier and Type Class and Description
sealed interface ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsProperties1Boxed
sealed interface for validated payloads
record ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsProperties1BoxedMap
boxed class to store validated Map payloads
static class ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsProperties1
schema class
static class ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsPropertiesMapBuilder
builder for Map payloads
static class ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsPropertiesMap
output class for Map payloads
sealed interface ObjectModelWithArgAndArgsProperties.ArgsBoxed
sealed interface for validated payloads
record ObjectModelWithArgAndArgsProperties.ArgsBoxedString
boxed class to store validated String payloads
static class ObjectModelWithArgAndArgsProperties.Args
schema class
sealed interface ObjectModelWithArgAndArgsProperties.ArgBoxed
sealed interface for validated payloads
record ObjectModelWithArgAndArgsProperties.ArgBoxedString
boxed class to store validated String payloads
static class ObjectModelWithArgAndArgsProperties.Arg
schema class

ObjectModelWithArgAndArgsProperties1Boxed

public sealed interface ObjectModelWithArgAndArgsProperties1Boxed
permits
ObjectModelWithArgAndArgsProperties1BoxedMap

sealed interface that stores validated payloads using boxed classes

ObjectModelWithArgAndArgsProperties1BoxedMap

public record ObjectModelWithArgAndArgsProperties1BoxedMap
implements ObjectModelWithArgAndArgsProperties1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ObjectModelWithArgAndArgsProperties1BoxedMap(ObjectModelWithArgAndArgsPropertiesMap data)
Creates an instance, private visibility

Method Summary

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

ObjectModelWithArgAndArgsProperties1

public static class ObjectModelWithArgAndArgsProperties1
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.ObjectModelWithArgAndArgsProperties;

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

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

// Map validation
ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsPropertiesMap validatedPayload =
    ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsProperties1.validate(
    new ObjectModelWithArgAndArgsProperties.ObjectModelWithArgAndArgsPropertiesMapBuilder()
        .arg("a")

        .args("a")

    .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("arg", Arg.class)),
    new PropertyEntry("args", Args.class))
)
Set required = Set.of(
    "arg",
    "args"
)

Method Summary

Modifier and Type Method and Description
ObjectModelWithArgAndArgsPropertiesMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
ObjectModelWithArgAndArgsProperties1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
ObjectModelWithArgAndArgsProperties1Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

ObjectModelWithArgAndArgsPropertiesMap00Builder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
ObjectModelWithArgAndArgsPropertiesMap00Builder(Map<String, @Nullable Object> instance)
Creates a builder that contains the passed instance

Method Summary

Modifier and Type Method and Description
Map<String, @Nullable Object> build()
Returns map input that should be used with Schema.validate
ObjectModelWithArgAndArgsPropertiesMap00Builder additionalProperty(String key, Void value)
ObjectModelWithArgAndArgsPropertiesMap00Builder additionalProperty(String key, boolean value)
ObjectModelWithArgAndArgsPropertiesMap00Builder additionalProperty(String key, String value)
ObjectModelWithArgAndArgsPropertiesMap00Builder additionalProperty(String key, int value)
ObjectModelWithArgAndArgsPropertiesMap00Builder additionalProperty(String key, float value)
ObjectModelWithArgAndArgsPropertiesMap00Builder additionalProperty(String key, long value)
ObjectModelWithArgAndArgsPropertiesMap00Builder additionalProperty(String key, double value)
ObjectModelWithArgAndArgsPropertiesMap00Builder additionalProperty(String key, List<?> value)
ObjectModelWithArgAndArgsPropertiesMap00Builder additionalProperty(String key, Map<String, ?> value)

ObjectModelWithArgAndArgsPropertiesMap01Builder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
ObjectModelWithArgAndArgsPropertiesMap01Builder(Map<String, @Nullable Object> instance)
Creates a builder that contains the passed instance

Method Summary

Modifier and Type Method and Description
ObjectModelWithArgAndArgsPropertiesMap00Builder args(String value)

ObjectModelWithArgAndArgsPropertiesMap10Builder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
ObjectModelWithArgAndArgsPropertiesMap10Builder(Map<String, @Nullable Object> instance)
Creates a builder that contains the passed instance

Method Summary

Modifier and Type Method and Description
ObjectModelWithArgAndArgsPropertiesMap00Builder arg(String value)

ObjectModelWithArgAndArgsPropertiesMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type Method and Description
ObjectModelWithArgAndArgsPropertiesMap01Builder arg(String value)
ObjectModelWithArgAndArgsPropertiesMap10Builder args(String value)

ObjectModelWithArgAndArgsPropertiesMap

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

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static ObjectModelWithArgAndArgsPropertiesMap of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
String arg()
String args()
@Nullable Object getAdditionalProperty(String name)
provides type safety for additional properties

ArgsBoxed

public sealed interface ArgsBoxed
permits
ArgsBoxedString

sealed interface that stores validated payloads using boxed classes

ArgsBoxedString

public record ArgsBoxedString
implements ArgsBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ArgsBoxedString(String data)
Creates an instance, private visibility

Method Summary

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

Args

public static class Args
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

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

ArgBoxed

public sealed interface ArgBoxed
permits
ArgBoxedString

sealed interface that stores validated payloads using boxed classes

ArgBoxedString

public record ArgBoxedString
implements ArgBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ArgBoxedString(String data)
Creates an instance, private visibility

Method Summary

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

Arg

public static class Arg
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

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

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