RootServer1Variables.md

RootServer1Variables

public class RootServer1Variables

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
• enum classes

Nested Class Summary

Modifier and Type	Class and Description
sealed interface	RootServer1Variables.RootServer1Variables1Boxed sealed interface for validated payloads
record	RootServer1Variables.RootServer1Variables1BoxedMap boxed class to store validated Map payloads
static class	RootServer1Variables.RootServer1Variables1 schema class
static class	RootServer1Variables.VariablesMapBuilder builder for Map payloads
static class	RootServer1Variables.VariablesMap output class for Map payloads
sealed interface	RootServer1Variables.VersionBoxed sealed interface for validated payloads
record	RootServer1Variables.VersionBoxedString boxed class to store validated String payloads
static class	RootServer1Variables.Version schema class
enum	RootServer1Variables.StringVersionEnums String enum
sealed interface	RootServer1Variables.AdditionalPropertiesBoxed sealed interface for validated payloads
record	RootServer1Variables.AdditionalPropertiesBoxedVoid boxed class to store validated null payloads
record	RootServer1Variables.AdditionalPropertiesBoxedBoolean boxed class to store validated boolean payloads
record	RootServer1Variables.AdditionalPropertiesBoxedNumber boxed class to store validated Number payloads
record	RootServer1Variables.AdditionalPropertiesBoxedString boxed class to store validated String payloads
record	RootServer1Variables.AdditionalPropertiesBoxedList boxed class to store validated List payloads
record	RootServer1Variables.AdditionalPropertiesBoxedMap boxed class to store validated Map payloads
static class	RootServer1Variables.AdditionalProperties schema class

RootServer1Variables1Boxed

public sealed interface RootServer1Variables1Boxed
permits
RootServer1Variables1BoxedMap

sealed interface that stores validated payloads using boxed classes

RootServer1Variables1BoxedMap

public record RootServer1Variables1BoxedMap
implements RootServer1Variables1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
RootServer1Variables1BoxedMap(VariablesMap data) Creates an instance, private visibility

Method Summary

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

RootServer1Variables1

public static class RootServer1Variables1
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.servers.rootserver1.RootServer1Variables;

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

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

// Map validation
RootServer1Variables.VariablesMap validatedPayload =
    RootServer1Variables.RootServer1Variables1.validate(
    new RootServer1Variables.VariablesMapBuilder()
        .version("v1")

    .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("version", Version.class)) )
Set	required = Set.of(     "version" )
Class<? extends JsonSchema>	additionalProperties = AdditionalProperties.class

Method Summary

Modifier and Type	Method and Description
VariablesMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
RootServer1Variables1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
RootServer1Variables1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

VariablesMap0Builder

public class VariablesMap0Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
Map<String, String>	build() Returns map input that should be used with Schema.validate

VariablesMapBuilder

public class VariablesMapBuilder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
VariablesMap0Builder	version(String value)
VariablesMap0Builder	version(StringVersionEnums value)

VariablesMap

public static class VariablesMap
extends FrozenMap<String, String>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static VariablesMap	of(Map<String, String> arg, SchemaConfiguration configuration)
String	version() must be one of ["v1", "v2"] if omitted the server will use the default value of v2

VersionBoxed

public sealed interface VersionBoxed
permits
VersionBoxedString

sealed interface that stores validated payloads using boxed classes

VersionBoxedString

public record VersionBoxedString
implements VersionBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Version

public static class Version
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.servers.rootserver1.RootServer1Variables;

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

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

// String validation
String validatedPayload = RootServer1Variables.Version.validate(
    "v1",
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(     String.class )
Set	enumValues = SetMaker.makeSet(     "v1",     "v2" )
@Nullable Object	defaultValue = "v2"

Method Summary

Modifier and Type	Method and Description
String	validate(String arg, SchemaConfiguration configuration)
String	validate(StringVersionEnums arg, SchemaConfiguration configuration)
VersionBoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
VersionBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

StringVersionEnums

public enum StringVersionEnums
extends Enum<StringVersionEnums>

A class that stores String enum values

Enum Constant Summary

Enum Constant	Description
V1	value = "v1"
V2	value = "v2"

AdditionalPropertiesBoxed

public sealed interface AdditionalPropertiesBoxed
permits
AdditionalPropertiesBoxedVoid, AdditionalPropertiesBoxedBoolean, AdditionalPropertiesBoxedNumber, AdditionalPropertiesBoxedString, AdditionalPropertiesBoxedList, AdditionalPropertiesBoxedMap

sealed interface that stores validated payloads using boxed classes

AdditionalPropertiesBoxedVoid

public record AdditionalPropertiesBoxedVoid
implements AdditionalPropertiesBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedVoid(Void data) Creates an instance, private visibility

Method Summary

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

AdditionalPropertiesBoxedBoolean

public record AdditionalPropertiesBoxedBoolean
implements AdditionalPropertiesBoxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedBoolean(boolean data) Creates an instance, private visibility

Method Summary

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

AdditionalPropertiesBoxedNumber

public record AdditionalPropertiesBoxedNumber
implements AdditionalPropertiesBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

AdditionalPropertiesBoxedString

public record AdditionalPropertiesBoxedString
implements AdditionalPropertiesBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

AdditionalPropertiesBoxedList

public record AdditionalPropertiesBoxedList
implements AdditionalPropertiesBoxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedList(FrozenList<@Nullable Object> data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
FrozenList<@Nullable Object>	data() validated payload
@Nullable Object	getData() validated payload

AdditionalPropertiesBoxedMap

public record AdditionalPropertiesBoxedMap
implements AdditionalPropertiesBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AdditionalPropertiesBoxedMap(FrozenMap<@Nullable Object> data) Creates an instance, private visibility

Method Summary

Modifier and Type	Method and Description
FrozenMap<@Nullable Object>	data() validated payload
@Nullable Object	getData() validated payload

AdditionalProperties

public static class AdditionalProperties
extends NotAnyTypeJsonSchema.NotAnyTypeJsonSchema1

A schema class that validates payloads

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