EnumClass.md

EnumClass

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

A class that contains necessary nested

• schema classes (which validate payloads), extends JsonSchema
• enum classes

Nested Class Summary

Modifier and Type	Class and Description
static class	EnumClass.EnumClass1 schema class
enum	EnumClass.StringEnumClassEnums String enum

EnumClass1

public static class EnumClass1
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 = EnumClass.EnumClass1.validate(
    "_abc",
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(     String.class )
Set	enumValues = SetMaker.makeSet(     "_abc",     "-efg",     "(xyz)",     "COUNT_1M",     "COUNT_50M" )
@Nullable Object	defaultValue = "-efg"

Method Summary

Modifier and Type	Method and Description
String	validate(String arg, SchemaConfiguration configuration)
String	validate(StringEnumClassEnums arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

StringEnumClassEnums

public enum StringEnumClassEnums
extends Enum<StringEnumClassEnums>

A class that stores String enum values

Enum Constant Summary

Enum Constant	Description
_ABC	value = "_abc"
HYPHEN_MINUS_EFG	value = "-efg"
LEFT_PARENTHESIS_XYZ_RIGHT_PARENTHESIS	value = "(xyz)"
COUNT_1M	value = "COUNT_1M"
COUNT_50M	value = "COUNT_50M"

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