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

Latest commit

 

History

History
378 lines (298 loc) · 15.2 KB

Server1.md

File metadata and controls

378 lines (298 loc) · 15.2 KB

org.openapijsonschematools.client.servers.Server1

Server Server1

public class Server1

A class that stores a server url

Description

The local server

Constructor Summary

Constructor and Description
Server1()
Creates a server using default values for variables
Server1(Variables.VariablesMap variables)
Creates a server using input values for variables

Field Summary

Modifier and Type Field and Description
String url = "https://localhost:8080/{version}"
Variables.VariablesMap variables

Variables

public class Variables

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 Variables.Variables1Boxed
sealed interface for validated payloads
record Variables.Variables1BoxedMap
boxed class to store validated Map payloads
static class Variables.Variables1
schema class
static class Variables.VariablesMapBuilder
builder for Map payloads
static class Variables.VariablesMap
output class for Map payloads
sealed interface Variables.VersionBoxed
sealed interface for validated payloads
record Variables.VersionBoxedString
boxed class to store validated String payloads
static class Variables.Version
schema class
enum Variables.StringVersionEnums
String enum
sealed interface Variables.AdditionalPropertiesBoxed
sealed interface for validated payloads
record Variables.AdditionalPropertiesBoxedVoid
boxed class to store validated null payloads
record Variables.AdditionalPropertiesBoxedBoolean
boxed class to store validated boolean payloads
record Variables.AdditionalPropertiesBoxedNumber
boxed class to store validated Number payloads
record Variables.AdditionalPropertiesBoxedString
boxed class to store validated String payloads
record Variables.AdditionalPropertiesBoxedList
boxed class to store validated List payloads
record Variables.AdditionalPropertiesBoxedMap
boxed class to store validated Map payloads
static class Variables.AdditionalProperties
schema class

Variables1Boxed

public sealed interface Variables1Boxed
permits
Variables1BoxedMap

sealed interface that stores validated payloads using boxed classes

Variables1BoxedMap

public record Variables1BoxedMap
implements Variables1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Variables1

public static class Variables1
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.server1.Variables;

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

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// Map validation
Variables.VariablesMap validatedPayload =
    Variables.Variables1.validate(
    new Variables.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)
Variables1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
Variables1Boxed 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.server1.Variables;

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

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// String validation
String validatedPayload = Variables.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

[Back to top] [Back to Servers] [Back to README]