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

Latest commit

 

History

History
351 lines (274 loc) · 14.2 KB

AppleReq.md

File metadata and controls

351 lines (274 loc) · 14.2 KB

AppleReq

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

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 AppleReq.AppleReq1Boxed
sealed interface for validated payloads
record AppleReq.AppleReq1BoxedMap
boxed class to store validated Map payloads
static class AppleReq.AppleReq1
schema class
static class AppleReq.AppleReqMapBuilder
builder for Map payloads
static class AppleReq.AppleReqMap
output class for Map payloads
sealed interface AppleReq.MealyBoxed
sealed interface for validated payloads
record AppleReq.MealyBoxedBoolean
boxed class to store validated boolean payloads
static class AppleReq.Mealy
schema class
sealed interface AppleReq.CultivarBoxed
sealed interface for validated payloads
record AppleReq.CultivarBoxedString
boxed class to store validated String payloads
static class AppleReq.Cultivar
schema class
sealed interface AppleReq.AdditionalPropertiesBoxed
sealed interface for validated payloads
record AppleReq.AdditionalPropertiesBoxedVoid
boxed class to store validated null payloads
record AppleReq.AdditionalPropertiesBoxedBoolean
boxed class to store validated boolean payloads
record AppleReq.AdditionalPropertiesBoxedNumber
boxed class to store validated Number payloads
record AppleReq.AdditionalPropertiesBoxedString
boxed class to store validated String payloads
record AppleReq.AdditionalPropertiesBoxedList
boxed class to store validated List payloads
record AppleReq.AdditionalPropertiesBoxedMap
boxed class to store validated Map payloads
static class AppleReq.AdditionalProperties
schema class

AppleReq1Boxed

public sealed interface AppleReq1Boxed
permits
AppleReq1BoxedMap

sealed interface that stores validated payloads using boxed classes

AppleReq1BoxedMap

public record AppleReq1BoxedMap
implements AppleReq1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
AppleReq1BoxedMap(AppleReqMap data)
Creates an instance, private visibility

Method Summary

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

AppleReq1

public static class AppleReq1
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.components.schemas.AppleReq;

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

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

// Map validation
AppleReq.AppleReqMap validatedPayload =
    AppleReq.AppleReq1.validate(
    new AppleReq.AppleReqMapBuilder()
        .cultivar("a")

        .mealy(true)

    .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("cultivar", Cultivar.class)),
    new PropertyEntry("mealy", Mealy.class))
)
Set required = Set.of(
    "cultivar"
)
Class<? extends JsonSchema> additionalProperties = AdditionalProperties.class

Method Summary

Modifier and Type Method and Description
AppleReqMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
AppleReq1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
AppleReq1Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

AppleReqMap0Builder

public class AppleReqMap0Builder
builder for Map<String, Object>

A class that builds the Map input type

Constructor Summary

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

Method Summary

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

AppleReqMapBuilder

public class AppleReqMapBuilder
builder for Map<String, Object>

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type Method and Description
AppleReqMap0Builder cultivar(String value)

AppleReqMap

public static class AppleReqMap
extends FrozenMap<String, Object>

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static AppleReqMap of(Map<String, Object> arg, SchemaConfiguration configuration)
String cultivar()
boolean mealy()
[optional]

MealyBoxed

public sealed interface MealyBoxed
permits
MealyBoxedBoolean

sealed interface that stores validated payloads using boxed classes

MealyBoxedBoolean

public record MealyBoxedBoolean
implements MealyBoxed

record that stores validated boolean payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Mealy

public static class Mealy
extends BooleanJsonSchema.BooleanJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.BooleanJsonSchema.BooleanJsonSchema1
validate
validateAndBox

CultivarBoxed

public sealed interface CultivarBoxed
permits
CultivarBoxedString

sealed interface that stores validated payloads using boxed classes

CultivarBoxedString

public record CultivarBoxedString
implements CultivarBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Cultivar

public static class Cultivar
extends StringJsonSchema.StringJsonSchema1

A schema class that validates payloads

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

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 Component Schemas] [Back to README]