Skip to content

Latest commit

 

History

History
539 lines (435 loc) · 32.3 KB

PropertiesWhoseNamesAreJavascriptObjectPropertyNames.md

File metadata and controls

539 lines (435 loc) · 32.3 KB

PropertiesWhoseNamesAreJavascriptObjectPropertyNames

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

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 PropertiesWhoseNamesAreJavascriptObjectPropertyNames.PropertiesWhoseNamesAreJavascriptObjectPropertyNames1Boxed
sealed interface for validated payloads
record PropertiesWhoseNamesAreJavascriptObjectPropertyNames.PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedVoid
boxed class to store validated null payloads
record PropertiesWhoseNamesAreJavascriptObjectPropertyNames.PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedBoolean
boxed class to store validated boolean payloads
record PropertiesWhoseNamesAreJavascriptObjectPropertyNames.PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedNumber
boxed class to store validated Number payloads
record PropertiesWhoseNamesAreJavascriptObjectPropertyNames.PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedString
boxed class to store validated String payloads
record PropertiesWhoseNamesAreJavascriptObjectPropertyNames.PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedList
boxed class to store validated List payloads
record PropertiesWhoseNamesAreJavascriptObjectPropertyNames.PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedMap
boxed class to store validated Map payloads
static class PropertiesWhoseNamesAreJavascriptObjectPropertyNames.PropertiesWhoseNamesAreJavascriptObjectPropertyNames1
schema class
static class PropertiesWhoseNamesAreJavascriptObjectPropertyNames.PropertiesWhoseNamesAreJavascriptObjectPropertyNamesMapBuilder
builder for Map payloads
static class PropertiesWhoseNamesAreJavascriptObjectPropertyNames.PropertiesWhoseNamesAreJavascriptObjectPropertyNamesMap
output class for Map payloads
sealed interface PropertiesWhoseNamesAreJavascriptObjectPropertyNames.ConstructorBoxed
sealed interface for validated payloads
record PropertiesWhoseNamesAreJavascriptObjectPropertyNames.ConstructorBoxedNumber
boxed class to store validated Number payloads
static class PropertiesWhoseNamesAreJavascriptObjectPropertyNames.Constructor
schema class
sealed interface PropertiesWhoseNamesAreJavascriptObjectPropertyNames.ToStringSchemaBoxed
sealed interface for validated payloads
record PropertiesWhoseNamesAreJavascriptObjectPropertyNames.ToStringSchemaBoxedVoid
boxed class to store validated null payloads
record PropertiesWhoseNamesAreJavascriptObjectPropertyNames.ToStringSchemaBoxedBoolean
boxed class to store validated boolean payloads
record PropertiesWhoseNamesAreJavascriptObjectPropertyNames.ToStringSchemaBoxedNumber
boxed class to store validated Number payloads
record PropertiesWhoseNamesAreJavascriptObjectPropertyNames.ToStringSchemaBoxedString
boxed class to store validated String payloads
record PropertiesWhoseNamesAreJavascriptObjectPropertyNames.ToStringSchemaBoxedList
boxed class to store validated List payloads
record PropertiesWhoseNamesAreJavascriptObjectPropertyNames.ToStringSchemaBoxedMap
boxed class to store validated Map payloads
static class PropertiesWhoseNamesAreJavascriptObjectPropertyNames.ToStringSchema
schema class
static class PropertiesWhoseNamesAreJavascriptObjectPropertyNames.ToStringMapBuilder
builder for Map payloads
static class PropertiesWhoseNamesAreJavascriptObjectPropertyNames.ToStringMap
output class for Map payloads
sealed interface PropertiesWhoseNamesAreJavascriptObjectPropertyNames.LengthBoxed
sealed interface for validated payloads
record PropertiesWhoseNamesAreJavascriptObjectPropertyNames.LengthBoxedString
boxed class to store validated String payloads
static class PropertiesWhoseNamesAreJavascriptObjectPropertyNames.Length
schema class
sealed interface PropertiesWhoseNamesAreJavascriptObjectPropertyNames.ProtoBoxed
sealed interface for validated payloads
record PropertiesWhoseNamesAreJavascriptObjectPropertyNames.ProtoBoxedNumber
boxed class to store validated Number payloads
static class PropertiesWhoseNamesAreJavascriptObjectPropertyNames.Proto
schema class

PropertiesWhoseNamesAreJavascriptObjectPropertyNames1Boxed

public sealed interface PropertiesWhoseNamesAreJavascriptObjectPropertyNames1Boxed
permits
PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedVoid, PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedBoolean, PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedNumber, PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedString, PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedList, PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedMap

sealed interface that stores validated payloads using boxed classes

PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedVoid

public record PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedVoid
implements PropertiesWhoseNamesAreJavascriptObjectPropertyNames1Boxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedBoolean

public record PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedBoolean
implements PropertiesWhoseNamesAreJavascriptObjectPropertyNames1Boxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedNumber

public record PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedNumber
implements PropertiesWhoseNamesAreJavascriptObjectPropertyNames1Boxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedString

public record PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedString
implements PropertiesWhoseNamesAreJavascriptObjectPropertyNames1Boxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedList

public record PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedList
implements PropertiesWhoseNamesAreJavascriptObjectPropertyNames1Boxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

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

PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedMap

public record PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedMap
implements PropertiesWhoseNamesAreJavascriptObjectPropertyNames1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedMap(PropertiesWhoseNamesAreJavascriptObjectPropertyNamesMap data)
Creates an instance, private visibility

Method Summary

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

PropertiesWhoseNamesAreJavascriptObjectPropertyNames1

public static class PropertiesWhoseNamesAreJavascriptObjectPropertyNames1
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("proto", Proto.class)),
    new PropertyEntry("toString", ToStringSchema.class)),
    new PropertyEntry("constructor", Constructor.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)
PropertiesWhoseNamesAreJavascriptObjectPropertyNamesMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object> validate(List<?> arg, SchemaConfiguration configuration)
PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedString validateAndBox(String arg, SchemaConfiguration configuration)
PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedVoid validateAndBox(Void arg, SchemaConfiguration configuration)
PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedNumber validateAndBox(Number arg, SchemaConfiguration configuration)
PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedBoolean validateAndBox(boolean arg, SchemaConfiguration configuration)
PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
PropertiesWhoseNamesAreJavascriptObjectPropertyNames1BoxedList validateAndBox(List<?> arg, SchemaConfiguration configuration)
PropertiesWhoseNamesAreJavascriptObjectPropertyNames1Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

PropertiesWhoseNamesAreJavascriptObjectPropertyNamesMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

PropertiesWhoseNamesAreJavascriptObjectPropertyNamesMap

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

A class to store validated Map payloads

Method Summary

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

ConstructorBoxed

public sealed interface ConstructorBoxed
permits
ConstructorBoxedNumber

sealed interface that stores validated payloads using boxed classes

ConstructorBoxedNumber

public record ConstructorBoxedNumber
implements ConstructorBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Constructor

public static class Constructor
extends NumberJsonSchema.NumberJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.NumberJsonSchema.NumberJsonSchema1
validate
validateAndBox

ToStringSchemaBoxed

public sealed interface ToStringSchemaBoxed
permits
ToStringSchemaBoxedVoid, ToStringSchemaBoxedBoolean, ToStringSchemaBoxedNumber, ToStringSchemaBoxedString, ToStringSchemaBoxedList, ToStringSchemaBoxedMap

sealed interface that stores validated payloads using boxed classes

ToStringSchemaBoxedVoid

public record ToStringSchemaBoxedVoid
implements ToStringSchemaBoxed

record that stores validated null payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

ToStringSchemaBoxedBoolean

public record ToStringSchemaBoxedBoolean
implements ToStringSchemaBoxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

ToStringSchemaBoxedNumber

public record ToStringSchemaBoxedNumber
implements ToStringSchemaBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

ToStringSchemaBoxedString

public record ToStringSchemaBoxedString
implements ToStringSchemaBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

ToStringSchemaBoxedList

public record ToStringSchemaBoxedList
implements ToStringSchemaBoxed

record that stores validated List payloads, sealed permits implementation

Constructor Summary

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

ToStringSchemaBoxedMap

public record ToStringSchemaBoxedMap
implements ToStringSchemaBoxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
ToStringSchemaBoxedMap(ToStringMap data)
Creates an instance, private visibility

Method Summary

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

ToStringSchema

public static class ToStringSchema
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("length", Length.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)
ToStringMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
FrozenList<@Nullable Object> validate(List<?> arg, SchemaConfiguration configuration)
ToStringSchemaBoxedString validateAndBox(String arg, SchemaConfiguration configuration)
ToStringSchemaBoxedVoid validateAndBox(Void arg, SchemaConfiguration configuration)
ToStringSchemaBoxedNumber validateAndBox(Number arg, SchemaConfiguration configuration)
ToStringSchemaBoxedBoolean validateAndBox(boolean arg, SchemaConfiguration configuration)
ToStringSchemaBoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
ToStringSchemaBoxedList validateAndBox(List<?> arg, SchemaConfiguration configuration)
ToStringSchemaBoxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

ToStringMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

ToStringMap

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

A class to store validated Map payloads

Method Summary

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

LengthBoxed

public sealed interface LengthBoxed
permits
LengthBoxedString

sealed interface that stores validated payloads using boxed classes

LengthBoxedString

public record LengthBoxedString
implements LengthBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Length

public static class Length
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

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

ProtoBoxed

public sealed interface ProtoBoxed
permits
ProtoBoxedNumber

sealed interface that stores validated payloads using boxed classes

ProtoBoxedNumber

public record ProtoBoxedNumber
implements ProtoBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Proto

public static class Proto
extends NumberJsonSchema.NumberJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.NumberJsonSchema.NumberJsonSchema1
validate
validateAndBox

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