EnumTest

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

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	EnumTest.EnumTest1Boxed sealed interface for validated payloads
record	EnumTest.EnumTest1BoxedMap boxed class to store validated Map payloads
static class	EnumTest.EnumTest1 schema class
static class	EnumTest.EnumTestMapBuilder builder for Map payloads
static class	EnumTest.EnumTestMap output class for Map payloads
sealed interface	EnumTest.EnumNumberBoxed sealed interface for validated payloads
record	EnumTest.EnumNumberBoxedNumber boxed class to store validated Number payloads
static class	EnumTest.EnumNumber schema class
enum	EnumTest.DoubleEnumNumberEnums Double enum
enum	EnumTest.FloatEnumNumberEnums Float enum
sealed interface	EnumTest.EnumIntegerBoxed sealed interface for validated payloads
record	EnumTest.EnumIntegerBoxedNumber boxed class to store validated Number payloads
static class	EnumTest.EnumInteger schema class
enum	EnumTest.IntegerEnumIntegerEnums Integer enum
enum	EnumTest.LongEnumIntegerEnums Long enum
enum	EnumTest.FloatEnumIntegerEnums Float enum
enum	EnumTest.DoubleEnumIntegerEnums Double enum
sealed interface	EnumTest.EnumStringRequiredBoxed sealed interface for validated payloads
record	EnumTest.EnumStringRequiredBoxedString boxed class to store validated String payloads
static class	EnumTest.EnumStringRequired schema class
enum	EnumTest.StringEnumStringRequiredEnums String enum
sealed interface	EnumTest.EnumStringBoxed sealed interface for validated payloads
record	EnumTest.EnumStringBoxedString boxed class to store validated String payloads
static class	EnumTest.EnumString schema class
enum	EnumTest.StringEnumStringEnums String enum

EnumTest1Boxed

public sealed interface EnumTest1Boxed
permits
EnumTest1BoxedMap

sealed interface that stores validated payloads using boxed classes

EnumTest1BoxedMap

public record EnumTest1BoxedMap
implements EnumTest1Boxed

record that stores validated Map payloads, sealed permits implementation

Constructor Summary

Constructor and Description
EnumTest1BoxedMap(EnumTestMap data) Creates an instance, private visibility

Method Summary

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

EnumTest1

public static class EnumTest1
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.EnumTest;

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

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

// Map validation
EnumTest.EnumTestMap validatedPayload =
    EnumTest.EnumTest1.validate(
    new EnumTest.EnumTestMapBuilder()
        .enum_string_required("UPPER")

        .enum_string("UPPER")

        .enum_integer(1)

        .enum_number(3.14d)

    .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("enum_string", EnumString.class)), new PropertyEntry("enum_string_required", EnumStringRequired.class)), new PropertyEntry("enum_integer", EnumInteger.class)), new PropertyEntry("enum_number", EnumNumber.class)), new PropertyEntry("stringEnum", StringEnum.StringEnum1.class), new PropertyEntry("IntegerEnum", IntegerEnum.IntegerEnum1.class), new PropertyEntry("StringEnumWithDefaultValue", StringEnumWithDefaultValue.StringEnumWithDefaultValue1.class), new PropertyEntry("IntegerEnumWithDefaultValue", IntegerEnumWithDefaultValue.IntegerEnumWithDefaultValue1.class), new PropertyEntry("IntegerEnumOneValue", IntegerEnumOneValue.IntegerEnumOneValue1.class) )
Set	required = Set.of( "enum_string_required" )

Method Summary

Modifier and Type	Method and Description
EnumTestMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
EnumTest1BoxedMap	validateAndBox(Map<?, ?> arg, SchemaConfiguration configuration)
EnumTest1Boxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

EnumTestMap0Builder

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

A class that builds the Map input type

Constructor Summary

Constructor and Description
EnumTestMap0Builder(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
EnumTestMap0Builder	enum_string(String value)
EnumTestMap0Builder	enum_string(StringEnumStringEnums value)
EnumTestMap0Builder	enum_integer(int value)
EnumTestMap0Builder	enum_integer(float value)
EnumTestMap0Builder	enum_integer(IntegerEnumIntegerEnums value)
EnumTestMap0Builder	enum_integer(LongEnumIntegerEnums value)
EnumTestMap0Builder	enum_integer(FloatEnumIntegerEnums value)
EnumTestMap0Builder	enum_integer(DoubleEnumIntegerEnums value)
EnumTestMap0Builder	enum_number(int value)
EnumTestMap0Builder	enum_number(float value)
EnumTestMap0Builder	enum_number(long value)
EnumTestMap0Builder	enum_number(double value)
EnumTestMap0Builder	enum_number(DoubleEnumNumberEnums value)
EnumTestMap0Builder	enum_number(FloatEnumNumberEnums value)
EnumTestMap0Builder	stringEnum(Void value)
EnumTestMap0Builder	stringEnum(String value)
EnumTestMap0Builder	stringEnum(StringEnum.StringStringEnumEnums value)
EnumTestMap0Builder	stringEnum(StringEnum.NullStringEnumEnums value)
EnumTestMap0Builder	IntegerEnum(int value)
EnumTestMap0Builder	IntegerEnum(float value)
EnumTestMap0Builder	IntegerEnum(long value)
EnumTestMap0Builder	IntegerEnum(double value)
EnumTestMap0Builder	IntegerEnum(IntegerEnum.IntegerIntegerEnumEnums value)
EnumTestMap0Builder	IntegerEnum(IntegerEnum.LongIntegerEnumEnums value)
EnumTestMap0Builder	IntegerEnum(IntegerEnum.FloatIntegerEnumEnums value)
EnumTestMap0Builder	IntegerEnum(IntegerEnum.DoubleIntegerEnumEnums value)
EnumTestMap0Builder	StringEnumWithDefaultValue(String value)
EnumTestMap0Builder	StringEnumWithDefaultValue(StringEnumWithDefaultValue.StringStringEnumWithDefaultValueEnums value)
EnumTestMap0Builder	IntegerEnumWithDefaultValue(int value)
EnumTestMap0Builder	IntegerEnumWithDefaultValue(float value)
EnumTestMap0Builder	IntegerEnumWithDefaultValue(long value)
EnumTestMap0Builder	IntegerEnumWithDefaultValue(double value)
EnumTestMap0Builder	IntegerEnumWithDefaultValue(IntegerEnumWithDefaultValue.IntegerIntegerEnumWithDefaultValueEnums value)
EnumTestMap0Builder	IntegerEnumWithDefaultValue(IntegerEnumWithDefaultValue.LongIntegerEnumWithDefaultValueEnums value)
EnumTestMap0Builder	IntegerEnumWithDefaultValue(IntegerEnumWithDefaultValue.FloatIntegerEnumWithDefaultValueEnums value)
EnumTestMap0Builder	IntegerEnumWithDefaultValue(IntegerEnumWithDefaultValue.DoubleIntegerEnumWithDefaultValueEnums value)
EnumTestMap0Builder	IntegerEnumOneValue(int value)
EnumTestMap0Builder	IntegerEnumOneValue(float value)
EnumTestMap0Builder	IntegerEnumOneValue(long value)
EnumTestMap0Builder	IntegerEnumOneValue(double value)
EnumTestMap0Builder	IntegerEnumOneValue(IntegerEnumOneValue.IntegerIntegerEnumOneValueEnums value)
EnumTestMap0Builder	IntegerEnumOneValue(IntegerEnumOneValue.LongIntegerEnumOneValueEnums value)
EnumTestMap0Builder	IntegerEnumOneValue(IntegerEnumOneValue.FloatIntegerEnumOneValueEnums value)
EnumTestMap0Builder	IntegerEnumOneValue(IntegerEnumOneValue.DoubleIntegerEnumOneValueEnums value)
EnumTestMap0Builder	additionalProperty(String key, Void value)
EnumTestMap0Builder	additionalProperty(String key, boolean value)
EnumTestMap0Builder	additionalProperty(String key, String value)
EnumTestMap0Builder	additionalProperty(String key, int value)
EnumTestMap0Builder	additionalProperty(String key, float value)
EnumTestMap0Builder	additionalProperty(String key, long value)
EnumTestMap0Builder	additionalProperty(String key, double value)
EnumTestMap0Builder	additionalProperty(String key, List<?> value)
EnumTestMap0Builder	additionalProperty(String key, Map<String, ?> value)

EnumTestMapBuilder

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

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
EnumTestMap0Builder	enum_string_required(String value)
EnumTestMap0Builder	enum_string_required(StringEnumStringRequiredEnums value)

EnumTestMap

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

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static EnumTestMap	of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
String	enum_string_required() must be one of ["UPPER", "lower", ""]
String	enum_string() [optional] must be one of ["UPPER", "lower", ""]
Number	enum_integer() [optional] must be one of [1, -1] value must be a 32 bit integer
Number	enum_number() [optional] must be one of [1.1, -1.2] value must be a 64 bit float
@Nullable String	stringEnum() [optional]
Number	IntegerEnum() [optional]
String	StringEnumWithDefaultValue() [optional]
Number	IntegerEnumWithDefaultValue() [optional]
Number	IntegerEnumOneValue() [optional]
@Nullable Object	getAdditionalProperty(String name) provides type safety for additional properties

EnumNumberBoxed

public sealed interface EnumNumberBoxed
permits
EnumNumberBoxedNumber

sealed interface that stores validated payloads using boxed classes

EnumNumberBoxedNumber

public record EnumNumberBoxedNumber
implements EnumNumberBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

EnumNumber

public static class EnumNumber
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.EnumTest;

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

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

// double validation
double validatedPayload = EnumTest.EnumNumber.validate(
    3.14d,
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of( Integer.class, Long.class, Float.class, Double.class )
String	type = "double";
Set	enumValues = SetMaker.makeSet( 1.1, -1.2 )

Method Summary

Modifier and Type	Method and Description
double	validate(double arg, SchemaConfiguration configuration)
EnumNumberBoxedNumber	validateAndBox(Number arg, SchemaConfiguration configuration)
EnumNumberBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

DoubleEnumNumberEnums

public enum DoubleEnumNumberEnums
extends Enum<DoubleEnumNumberEnums>

A class that stores Double enum values

Enum Constant Summary

Enum Constant	Description
POSITIVE_1_PT_1	value = 1.1d
NEGATIVE_1_PT_2	value = -1.2d

FloatEnumNumberEnums

public enum FloatEnumNumberEnums
extends Enum<FloatEnumNumberEnums>

A class that stores Float enum values

Enum Constant Summary

Enum Constant	Description
POSITIVE_1_PT_1	value = 1.1f
NEGATIVE_1_PT_2	value = -1.2f

EnumIntegerBoxed

public sealed interface EnumIntegerBoxed
permits
EnumIntegerBoxedNumber

sealed interface that stores validated payloads using boxed classes

EnumIntegerBoxedNumber

public record EnumIntegerBoxedNumber
implements EnumIntegerBoxed

record that stores validated Number payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

EnumInteger

public static class EnumInteger
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.EnumTest;

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

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

// int validation
int validatedPayload = EnumTest.EnumInteger.validate(
    1,
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of( Integer.class, Long.class, Float.class, Double.class )
String	type = "int32";
Set	enumValues = SetMaker.makeSet( 1, -1 )

Method Summary

Modifier and Type	Method and Description
int	validate(int arg, SchemaConfiguration configuration)
EnumIntegerBoxedNumber	validateAndBox(Number arg, SchemaConfiguration configuration)
EnumIntegerBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

IntegerEnumIntegerEnums

public enum IntegerEnumIntegerEnums
extends Enum<IntegerEnumIntegerEnums>

A class that stores Integer enum values

Enum Constant Summary

Enum Constant	Description
POSITIVE_1	value = 1
NEGATIVE_1	value = -1

LongEnumIntegerEnums

public enum LongEnumIntegerEnums
extends Enum<LongEnumIntegerEnums>

A class that stores Long enum values

Enum Constant Summary

Enum Constant	Description
POSITIVE_1	value = 1L
NEGATIVE_1	value = -1L

FloatEnumIntegerEnums

public enum FloatEnumIntegerEnums
extends Enum<FloatEnumIntegerEnums>

A class that stores Float enum values

Enum Constant Summary

Enum Constant	Description
POSITIVE_1	value = 1.0f
NEGATIVE_1	value = -1.0f

DoubleEnumIntegerEnums

public enum DoubleEnumIntegerEnums
extends Enum<DoubleEnumIntegerEnums>

A class that stores Double enum values

Enum Constant Summary

Enum Constant	Description
POSITIVE_1	value = 1.0d
NEGATIVE_1	value = -1.0d

EnumStringRequiredBoxed

public sealed interface EnumStringRequiredBoxed
permits
EnumStringRequiredBoxedString

sealed interface that stores validated payloads using boxed classes

EnumStringRequiredBoxedString

public record EnumStringRequiredBoxedString
implements EnumStringRequiredBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

EnumStringRequired

public static class EnumStringRequired
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.EnumTest;

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 = EnumTest.EnumStringRequired.validate(
    "UPPER",
    configuration
);

Field Summary

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

Method Summary

Modifier and Type	Method and Description
String	validate(String arg, SchemaConfiguration configuration)
String	validate(StringEnumStringRequiredEnums arg, SchemaConfiguration configuration)
EnumStringRequiredBoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
EnumStringRequiredBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

StringEnumStringRequiredEnums

public enum StringEnumStringRequiredEnums
extends Enum<StringEnumStringRequiredEnums>

A class that stores String enum values

Enum Constant Summary

Enum Constant	Description
UPPER	value = "UPPER"
LOWER	value = "lower"
EMPTY	value = ""

EnumStringBoxed

public sealed interface EnumStringBoxed
permits
EnumStringBoxedString

sealed interface that stores validated payloads using boxed classes

EnumStringBoxedString

public record EnumStringBoxedString
implements EnumStringBoxed

record that stores validated String payloads, sealed permits implementation

Constructor Summary

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

Method Summary

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

EnumString

public static class EnumString
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.EnumTest;

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 = EnumTest.EnumString.validate(
    "UPPER",
    configuration
);

Field Summary

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

Method Summary

Modifier and Type	Method and Description
String	validate(String arg, SchemaConfiguration configuration)
String	validate(StringEnumStringEnums arg, SchemaConfiguration configuration)
EnumStringBoxedString	validateAndBox(String arg, SchemaConfiguration configuration)
EnumStringBoxed	validateAndBox(@Nullable Object arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

StringEnumStringEnums

public enum StringEnumStringEnums
extends Enum<StringEnumStringEnums>

A class that stores String enum values

Enum Constant Summary

Enum Constant	Description
UPPER	value = "UPPER"
LOWER	value = "lower"
EMPTY	value = ""

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

Files

EnumTest.md

Latest commit

History

EnumTest.md

File metadata and controls

EnumTest

Nested Class Summary

EnumTest1Boxed

EnumTest1BoxedMap

Constructor Summary

Method Summary

EnumTest1

Code Sample

Field Summary

Method Summary

EnumTestMap0Builder

Constructor Summary

Method Summary

EnumTestMapBuilder

Constructor Summary

Method Summary

EnumTestMap

Method Summary

EnumNumberBoxed

EnumNumberBoxedNumber

Constructor Summary

Method Summary

EnumNumber

Code Sample

Field Summary

Method Summary

DoubleEnumNumberEnums

Enum Constant Summary

FloatEnumNumberEnums

Enum Constant Summary

EnumIntegerBoxed

EnumIntegerBoxedNumber

Constructor Summary

Method Summary

EnumInteger

Code Sample

Field Summary

Method Summary

IntegerEnumIntegerEnums

Enum Constant Summary

LongEnumIntegerEnums

Enum Constant Summary

FloatEnumIntegerEnums

Enum Constant Summary

DoubleEnumIntegerEnums

Enum Constant Summary

EnumStringRequiredBoxed

EnumStringRequiredBoxedString

Constructor Summary

Method Summary

EnumStringRequired

Code Sample

Field Summary

Method Summary

StringEnumStringRequiredEnums

Enum Constant Summary

EnumStringBoxed

EnumStringBoxedString

Constructor Summary

Method Summary

EnumString

Code Sample

Field Summary

Method Summary

StringEnumStringEnums

Enum Constant Summary