Skip to content

Latest commit

 

History

History
674 lines (541 loc) · 29.7 KB

File metadata and controls

674 lines (541 loc) · 29.7 KB

AnyofComplexTypes

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

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 AnyofComplexTypes.AnyofComplexTypes1Boxed
sealed interface for validated payloads
record AnyofComplexTypes.AnyofComplexTypes1BoxedVoid
boxed class to store validated null payloads
record AnyofComplexTypes.AnyofComplexTypes1BoxedBoolean
boxed class to store validated boolean payloads
record AnyofComplexTypes.AnyofComplexTypes1BoxedNumber
boxed class to store validated Number payloads
record AnyofComplexTypes.AnyofComplexTypes1BoxedString
boxed class to store validated String payloads
record AnyofComplexTypes.AnyofComplexTypes1BoxedList
boxed class to store validated List payloads
record AnyofComplexTypes.AnyofComplexTypes1BoxedMap
boxed class to store validated Map payloads
static class AnyofComplexTypes.AnyofComplexTypes1
schema class
sealed interface AnyofComplexTypes.Schema1Boxed
sealed interface for validated payloads
record AnyofComplexTypes.Schema1BoxedVoid
boxed class to store validated null payloads
record AnyofComplexTypes.Schema1BoxedBoolean
boxed class to store validated boolean payloads
record AnyofComplexTypes.Schema1BoxedNumber
boxed class to store validated Number payloads
record AnyofComplexTypes.Schema1BoxedString
boxed class to store validated String payloads
record AnyofComplexTypes.Schema1BoxedList
boxed class to store validated List payloads
record AnyofComplexTypes.Schema1BoxedMap
boxed class to store validated Map payloads
static class AnyofComplexTypes.Schema1
schema class
static class AnyofComplexTypes.Schema1MapBuilder
builder for Map payloads
static class AnyofComplexTypes.Schema1Map
output class for Map payloads
sealed interface AnyofComplexTypes.FooBoxed
sealed interface for validated payloads
record AnyofComplexTypes.FooBoxedString
boxed class to store validated String payloads
static class AnyofComplexTypes.Foo
schema class
sealed interface AnyofComplexTypes.Schema0Boxed
sealed interface for validated payloads
record AnyofComplexTypes.Schema0BoxedVoid
boxed class to store validated null payloads
record AnyofComplexTypes.Schema0BoxedBoolean
boxed class to store validated boolean payloads
record AnyofComplexTypes.Schema0BoxedNumber
boxed class to store validated Number payloads
record AnyofComplexTypes.Schema0BoxedString
boxed class to store validated String payloads
record AnyofComplexTypes.Schema0BoxedList
boxed class to store validated List payloads
record AnyofComplexTypes.Schema0BoxedMap
boxed class to store validated Map payloads
static class AnyofComplexTypes.Schema0
schema class
static class AnyofComplexTypes.Schema0MapBuilder
builder for Map payloads
static class AnyofComplexTypes.Schema0Map
output class for Map payloads
sealed interface AnyofComplexTypes.BarBoxed
sealed interface for validated payloads
record AnyofComplexTypes.BarBoxedNumber
boxed class to store validated Number payloads
static class AnyofComplexTypes.Bar
schema class

AnyofComplexTypes1Boxed

public sealed interface AnyofComplexTypes1Boxed
permits
AnyofComplexTypes1BoxedVoid, AnyofComplexTypes1BoxedBoolean, AnyofComplexTypes1BoxedNumber, AnyofComplexTypes1BoxedString, AnyofComplexTypes1BoxedList, AnyofComplexTypes1BoxedMap

sealed interface that stores validated payloads using boxed classes

AnyofComplexTypes1BoxedVoid

public record AnyofComplexTypes1BoxedVoid
implements AnyofComplexTypes1Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

AnyofComplexTypes1BoxedBoolean

public record AnyofComplexTypes1BoxedBoolean
implements AnyofComplexTypes1Boxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

AnyofComplexTypes1BoxedNumber

public record AnyofComplexTypes1BoxedNumber
implements AnyofComplexTypes1Boxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

AnyofComplexTypes1BoxedString

public record AnyofComplexTypes1BoxedString
implements AnyofComplexTypes1Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

AnyofComplexTypes1BoxedList

public record AnyofComplexTypes1BoxedList
implements AnyofComplexTypes1Boxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

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

AnyofComplexTypes1BoxedMap

public record AnyofComplexTypes1BoxedMap
implements AnyofComplexTypes1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

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

AnyofComplexTypes1

public static class AnyofComplexTypes1
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type Field and Description
List<Class<? extends JsonSchema>> anyOf = List.of(
    Schema0.class,
    Schema1.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)
FrozenMap<@Nullable Object> validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object> validate(List<?> arg, SchemaConfiguration configuration)
AnyofComplexTypes1BoxedString validateAndBox(String arg, SchemaConfiguration configuration)
AnyofComplexTypes1BoxedVoid validateAndBox(Void arg, SchemaConfiguration configuration)
AnyofComplexTypes1BoxedNumber validateAndBox(Number arg, SchemaConfiguration configuration)
AnyofComplexTypes1BoxedBoolean validateAndBox(boolean arg, SchemaConfiguration configuration)
AnyofComplexTypes1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
AnyofComplexTypes1BoxedList validateAndBox(List<?> arg, SchemaConfiguration configuration)
AnyofComplexTypes1Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

Schema1Boxed

public sealed interface Schema1Boxed
permits
Schema1BoxedVoid, Schema1BoxedBoolean, Schema1BoxedNumber, Schema1BoxedString, Schema1BoxedList, Schema1BoxedMap

sealed interface that stores validated payloads using boxed classes

Schema1BoxedVoid

public record Schema1BoxedVoid
implements Schema1Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Schema1BoxedBoolean

public record Schema1BoxedBoolean
implements Schema1Boxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Schema1BoxedNumber

public record Schema1BoxedNumber
implements Schema1Boxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Schema1BoxedString

public record Schema1BoxedString
implements Schema1Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Schema1BoxedList

public record Schema1BoxedList
implements Schema1Boxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

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

Schema1BoxedMap

public record Schema1BoxedMap
implements Schema1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
Schema1BoxedMap(Schema1Map data)
Creates an instance, private visibility

Method Summary

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

Schema1

public static class Schema1
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type Field and Description
Map<String, Class<? extends JsonSchema>> properties = Map.ofEntries(
    new PropertyEntry("foo", Foo.class))
)
Set required = Set.of(
    "foo"
)

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)
Schema1Map validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object> validate(List<?> arg, SchemaConfiguration configuration)
Schema1BoxedString validateAndBox(String arg, SchemaConfiguration configuration)
Schema1BoxedVoid validateAndBox(Void arg, SchemaConfiguration configuration)
Schema1BoxedNumber validateAndBox(Number arg, SchemaConfiguration configuration)
Schema1BoxedBoolean validateAndBox(boolean arg, SchemaConfiguration configuration)
Schema1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
Schema1BoxedList validateAndBox(List<?> arg, SchemaConfiguration configuration)
Schema1Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

Schema1Map0Builder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
Schema1Map0Builder(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
Schema1Map0Builder additionalProperty(String key, Void value)
Schema1Map0Builder additionalProperty(String key, boolean value)
Schema1Map0Builder additionalProperty(String key, String value)
Schema1Map0Builder additionalProperty(String key, int value)
Schema1Map0Builder additionalProperty(String key, float value)
Schema1Map0Builder additionalProperty(String key, long value)
Schema1Map0Builder additionalProperty(String key, double value)
Schema1Map0Builder additionalProperty(String key, List<?> value)
Schema1Map0Builder additionalProperty(String key, Map<String, ?> value)

Schema1MapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type Method and Description
Schema1Map0Builder foo(String value)

Schema1Map

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

A class to store validated Map payloads

Method Summary

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

FooBoxed

public sealed interface FooBoxed
permits
FooBoxedString

sealed interface that stores validated payloads using boxed classes

FooBoxedString

public record FooBoxedString
implements FooBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Foo

public static class Foo
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

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

Schema0Boxed

public sealed interface Schema0Boxed
permits
Schema0BoxedVoid, Schema0BoxedBoolean, Schema0BoxedNumber, Schema0BoxedString, Schema0BoxedList, Schema0BoxedMap

sealed interface that stores validated payloads using boxed classes

Schema0BoxedVoid

public record Schema0BoxedVoid
implements Schema0Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Schema0BoxedBoolean

public record Schema0BoxedBoolean
implements Schema0Boxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Schema0BoxedNumber

public record Schema0BoxedNumber
implements Schema0Boxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Schema0BoxedString

public record Schema0BoxedString
implements Schema0Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Schema0BoxedList

public record Schema0BoxedList
implements Schema0Boxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

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

Schema0BoxedMap

public record Schema0BoxedMap
implements Schema0Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
Schema0BoxedMap(Schema0Map data)
Creates an instance, private visibility

Method Summary

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

Schema0

public static class Schema0
extends JsonSchema

A schema class that validates payloads

Field Summary

Modifier and Type Field and Description
Map<String, Class<? extends JsonSchema>> properties = Map.ofEntries(
    new PropertyEntry("bar", Bar.class))
)
Set required = Set.of(
    "bar"
)

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)
Schema0Map validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object> validate(List<?> arg, SchemaConfiguration configuration)
Schema0BoxedString validateAndBox(String arg, SchemaConfiguration configuration)
Schema0BoxedVoid validateAndBox(Void arg, SchemaConfiguration configuration)
Schema0BoxedNumber validateAndBox(Number arg, SchemaConfiguration configuration)
Schema0BoxedBoolean validateAndBox(boolean arg, SchemaConfiguration configuration)
Schema0BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
Schema0BoxedList validateAndBox(List<?> arg, SchemaConfiguration configuration)
Schema0Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

Schema0Map0Builder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
Schema0Map0Builder(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
Schema0Map0Builder additionalProperty(String key, Void value)
Schema0Map0Builder additionalProperty(String key, boolean value)
Schema0Map0Builder additionalProperty(String key, String value)
Schema0Map0Builder additionalProperty(String key, int value)
Schema0Map0Builder additionalProperty(String key, float value)
Schema0Map0Builder additionalProperty(String key, long value)
Schema0Map0Builder additionalProperty(String key, double value)
Schema0Map0Builder additionalProperty(String key, List<?> value)
Schema0Map0Builder additionalProperty(String key, Map<String, ?> value)

Schema0MapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type Method and Description
Schema0Map0Builder bar(int value)
Schema0Map0Builder bar(float value)
Schema0Map0Builder bar(long value)
Schema0Map0Builder bar(double value)

Schema0Map

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

A class to store validated Map payloads

Method Summary

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

BarBoxed

public sealed interface BarBoxed
permits
BarBoxedNumber

sealed interface that stores validated payloads using boxed classes

BarBoxedNumber

public record BarBoxedNumber
implements BarBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Bar

public static class Bar
extends IntJsonSchema.IntJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.IntJsonSchema.IntJsonSchema1
validate
validateAndBox

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