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

Latest commit

 

History

History
456 lines (363 loc) · 18.7 KB

Zebra.md

File metadata and controls

456 lines (363 loc) · 18.7 KB

Zebra

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

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 Zebra.Zebra1Boxed
sealed interface for validated payloads
record Zebra.Zebra1BoxedMap
boxed class to store validated Map payloads
static class Zebra.Zebra1
schema class
static class Zebra.ZebraMapBuilder
builder for Map payloads
static class Zebra.ZebraMap
output class for Map payloads
sealed interface Zebra.ClassNameBoxed
sealed interface for validated payloads
record Zebra.ClassNameBoxedString
boxed class to store validated String payloads
static class Zebra.ClassName
schema class
enum Zebra.StringClassNameEnums
String enum
sealed interface Zebra.TypeBoxed
sealed interface for validated payloads
record Zebra.TypeBoxedString
boxed class to store validated String payloads
static class Zebra.Type
schema class
enum Zebra.StringTypeEnums
String enum
sealed interface Zebra.AdditionalPropertiesBoxed
sealed interface for validated payloads
record Zebra.AdditionalPropertiesBoxedVoid
boxed class to store validated null payloads
record Zebra.AdditionalPropertiesBoxedBoolean
boxed class to store validated boolean payloads
record Zebra.AdditionalPropertiesBoxedNumber
boxed class to store validated Number payloads
record Zebra.AdditionalPropertiesBoxedString
boxed class to store validated String payloads
record Zebra.AdditionalPropertiesBoxedList
boxed class to store validated List payloads
record Zebra.AdditionalPropertiesBoxedMap
boxed class to store validated Map payloads
static class Zebra.AdditionalProperties
schema class

Zebra1Boxed

public sealed interface Zebra1Boxed
permits
Zebra1BoxedMap

sealed interface that stores validated payloads using boxed classes

Zebra1BoxedMap

public record Zebra1BoxedMap
implements Zebra1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
Zebra1BoxedMap(ZebraMap data)
Creates an instance, private visibility

Method Summary

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

Zebra1

public static class Zebra1
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.Zebra;

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

static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());

// Map validation
Zebra.ZebraMap validatedPayload =
    Zebra.Zebra1.validate(
    new Zebra.ZebraMapBuilder()
        .className("zebra")

        .type("plains")

    .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("type", Type.class)),
    new PropertyEntry("className", ClassName.class))
)
Set required = Set.of(
    "className"
)
Class<? extends JsonSchema> additionalProperties = AdditionalProperties.class

Method Summary

Modifier and Type Method and Description
ZebraMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
Zebra1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
Zebra1Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

ZebraMap0Builder

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

A class that builds the Map input type

Constructor Summary

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

ZebraMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type Method and Description
ZebraMap0Builder className(String value)
ZebraMap0Builder className(StringClassNameEnums value)

ZebraMap

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

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static ZebraMap of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
String className()
must be one of ["zebra"]
String type()
[optional] must be one of ["plains", "mountain", "grevys"]
@Nullable Object getAdditionalProperty(String name)
provides type safety for additional properties

ClassNameBoxed

public sealed interface ClassNameBoxed
permits
ClassNameBoxedString

sealed interface that stores validated payloads using boxed classes

ClassNameBoxedString

public record ClassNameBoxedString
implements ClassNameBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

ClassName

public static class ClassName
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.Zebra;

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

static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());

// String validation
String validatedPayload = Zebra.ClassName.validate(
    "zebra",
    configuration
);

Field Summary

Modifier and Type Field and Description
Set<Class<?>> type = Set.of(
    String.class
)
Set enumValues = SetMaker.makeSet(
    "zebra"
)

Method Summary

Modifier and Type Method and Description
String validate(String arg, SchemaConfiguration configuration)
String validate(StringClassNameEnums arg, SchemaConfiguration configuration)
ClassNameBoxedString validateAndBox(String arg, SchemaConfiguration configuration)
ClassNameBoxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

StringClassNameEnums

public enum StringClassNameEnums
extends Enum<StringClassNameEnums>

A class that stores String enum values

Enum Constant Summary

Enum Constant Description
ZEBRA value = "zebra"

TypeBoxed

public sealed interface TypeBoxed
permits
TypeBoxedString

sealed interface that stores validated payloads using boxed classes

TypeBoxedString

public record TypeBoxedString
implements TypeBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

Type

public static class Type
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.Zebra;

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

static final SchemaConfiguration configuration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());

// String validation
String validatedPayload = Zebra.Type.validate(
    "plains",
    configuration
);

Field Summary

Modifier and Type Field and Description
Set<Class<?>> type = Set.of(
    String.class
)
Set enumValues = SetMaker.makeSet(
    "plains",
    "mountain",
    "grevys"
)

Method Summary

Modifier and Type Method and Description
String validate(String arg, SchemaConfiguration configuration)
String validate(StringTypeEnums arg, SchemaConfiguration configuration)
TypeBoxedString validateAndBox(String arg, SchemaConfiguration configuration)
TypeBoxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

StringTypeEnums

public enum StringTypeEnums
extends Enum<StringTypeEnums>

A class that stores String enum values

Enum Constant Summary

Enum Constant Description
PLAINS value = "plains"
MOUNTAIN value = "mountain"
GREVYS value = "grevys"

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 AnyTypeJsonSchema.AnyTypeJsonSchema1

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.AnyTypeJsonSchema.AnyTypeJsonSchema1
validate
validateAndBox

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