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

Latest commit

 

History

History
232 lines (186 loc) · 9.75 KB

DanishPig.md

File metadata and controls

232 lines (186 loc) · 9.75 KB

DanishPig

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

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 DanishPig.DanishPig1Boxed
sealed interface for validated payloads
record DanishPig.DanishPig1BoxedMap
boxed class to store validated Map payloads
static class DanishPig.DanishPig1
schema class
static class DanishPig.DanishPigMapBuilder
builder for Map payloads
static class DanishPig.DanishPigMap
output class for Map payloads
sealed interface DanishPig.ClassNameBoxed
sealed interface for validated payloads
record DanishPig.ClassNameBoxedString
boxed class to store validated String payloads
static class DanishPig.ClassName
schema class
enum DanishPig.StringClassNameEnums
String enum

DanishPig1Boxed

public sealed interface DanishPig1Boxed
permits
DanishPig1BoxedMap

sealed interface that stores validated payloads using boxed classes

DanishPig1BoxedMap

public record DanishPig1BoxedMap
implements DanishPig1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
DanishPig1BoxedMap(DanishPigMap data)
Creates an instance, private visibility

Method Summary

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

DanishPig1

public static class DanishPig1
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.DanishPig;

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

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

// Map validation
DanishPig.DanishPigMap validatedPayload =
    DanishPig.DanishPig1.validate(
    new DanishPig.DanishPigMapBuilder()
        .className("DanishPig")

    .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("className", ClassName.class))
)
Set required = Set.of(
    "className"
)

Method Summary

Modifier and Type Method and Description
DanishPigMap validate(Map<?, ?> arg, SchemaConfiguration configuration)
DanishPig1BoxedMap validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
DanishPig1Boxed validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object validate(@Nullable Object arg, SchemaConfiguration configuration)

DanishPigMap0Builder

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

A class that builds the Map input type

Constructor Summary

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

DanishPigMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

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

DanishPigMap

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

A class to store validated Map payloads

Method Summary

Modifier and Type Method and Description
static DanishPigMap of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
String className()
must be one of ["DanishPig"]
@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.DanishPig;

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 = DanishPig.ClassName.validate(
    "DanishPig",
    configuration
);

Field Summary

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

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
DANISH_PIG value = "DanishPig"

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