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

Latest commit

 

History

History
297 lines (237 loc) · 14.2 KB

File metadata and controls

297 lines (237 loc) · 14.2 KB

Schema200Response

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

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 Schema200Response.Schema200Response1Boxed
sealed interface for validated payloads
record Schema200Response.Schema200Response1BoxedVoid
boxed class to store validated null payloads
record Schema200Response.Schema200Response1BoxedBoolean
boxed class to store validated boolean payloads
record Schema200Response.Schema200Response1BoxedNumber
boxed class to store validated Number payloads
record Schema200Response.Schema200Response1BoxedString
boxed class to store validated String payloads
record Schema200Response.Schema200Response1BoxedList
boxed class to store validated List payloads
record Schema200Response.Schema200Response1BoxedMap
boxed class to store validated Map payloads
static class Schema200Response.Schema200Response1
schema class
static class Schema200Response.Schema200ResponseMapBuilder
builder for Map payloads
static class Schema200Response.Schema200ResponseMap
output class for Map payloads
sealed interface Schema200Response.ClassSchemaBoxed
sealed interface for validated payloads
record Schema200Response.ClassSchemaBoxedString
boxed class to store validated String payloads
static class Schema200Response.ClassSchema
schema class
sealed interface Schema200Response.NameBoxed
sealed interface for validated payloads
record Schema200Response.NameBoxedNumber
boxed class to store validated Number payloads
static class Schema200Response.Name
schema class

Schema200Response1Boxed

public sealed interface Schema200Response1Boxed
permits
Schema200Response1BoxedVoid, Schema200Response1BoxedBoolean, Schema200Response1BoxedNumber, Schema200Response1BoxedString, Schema200Response1BoxedList, Schema200Response1BoxedMap

sealed interface that stores validated payloads using boxed classes

Schema200Response1BoxedVoid

public record Schema200Response1BoxedVoid
implements Schema200Response1Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Schema200Response1BoxedBoolean

public record Schema200Response1BoxedBoolean
implements Schema200Response1Boxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Schema200Response1BoxedNumber

public record Schema200Response1BoxedNumber
implements Schema200Response1Boxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Schema200Response1BoxedString

public record Schema200Response1BoxedString
implements Schema200Response1Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Schema200Response1BoxedList

public record Schema200Response1BoxedList
implements Schema200Response1Boxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

Constructor and Description
Schema200Response1BoxedList(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

Schema200Response1BoxedMap

public record Schema200Response1BoxedMap
implements Schema200Response1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
Schema200Response1BoxedMap(Schema200ResponseMap data)
Creates an instance, private visibility

Method Summary

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

Schema200Response1

public static class Schema200Response1
extends JsonSchema

A schema class that validates payloads

Description

model with an invalid class name for python, starts with a number

Field Summary

Modifier and Type Field and Description
Map<String, Class<? extends JsonSchema>> properties = Map.ofEntries(
    new PropertyEntry("name", Name.class)),
    new PropertyEntry("class", ClassSchema.class))
)

Method Summary

Modifier and Type Method and Description
String validate(String arg, SchemaConfiguration configuration)
Void validate(Void arg, SchemaConfiguration configuration)
int validate(int arg, SchemaConfiguration configuration)
long validate(long arg, SchemaConfiguration configuration)
float validate(float arg, SchemaConfiguration configuration)
double validate(double arg, SchemaConfiguration configuration)
Number validate(Number arg, SchemaConfiguration configuration)
boolean validate(boolean arg, SchemaConfiguration configuration)
Schema200ResponseMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object> validate(List<?> arg, SchemaConfiguration configuration)
Schema200Response1BoxedString validateAndBox(String arg, SchemaConfiguration configuration)
Schema200Response1BoxedVoid validateAndBox(Void arg, SchemaConfiguration configuration)
Schema200Response1BoxedNumber validateAndBox(Number arg, SchemaConfiguration configuration)
Schema200Response1BoxedBoolean validateAndBox(boolean arg, SchemaConfiguration configuration)
Schema200Response1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
Schema200Response1BoxedList validateAndBox(List<?> arg, SchemaConfiguration configuration)
Schema200Response1Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

Schema200ResponseMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

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

Schema200ResponseMap

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

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static Schema200ResponseMap of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
Number name()
[optional] value must be a 32 bit integer
@Nullable Object get(String key)
This schema has invalid Java names so this method must be used when you access instance["class"],
@Nullable Object getAdditionalProperty(String name)
provides type safety for additional properties

ClassSchemaBoxed

public sealed interface ClassSchemaBoxed
permits
ClassSchemaBoxedString

sealed interface that stores validated payloads using boxed classes

ClassSchemaBoxedString

public record ClassSchemaBoxedString
implements ClassSchemaBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

ClassSchema

public static class ClassSchema
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

Description

this is a reserved python keyword

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

NameBoxed

public sealed interface NameBoxed
permits
NameBoxedNumber

sealed interface that stores validated payloads using boxed classes

NameBoxedNumber

public record NameBoxedNumber
implements NameBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Name

public static class Name
extends Int32JsonSchema.Int32JsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.Int32JsonSchema.Int32JsonSchema1
validate
validateAndBox

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