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

Latest commit

 

History

History
242 lines (196 loc) · 9.6 KB

Zebra.md

File metadata and controls

242 lines (196 loc) · 9.6 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
  • 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
static class Zebra.Zebra1
schema class
static class Zebra.ZebraMapBuilder
builder for Map payloads
static class Zebra.ZebraMap
output class for Map payloads
static class Zebra.ClassName
schema class
enum Zebra.StringClassNameEnums
String enum
static class Zebra.Type
schema class
enum Zebra.StringTypeEnums
String enum
static class Zebra.AdditionalProperties
schema class

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

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

// 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)
@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

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

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

// 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)
@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"

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 java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

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

// 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)
@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"

AdditionalProperties

public static class AdditionalProperties
extends AnyTypeJsonSchema

A schema class that validates payloads

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

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